Skip to content

docs: break testing doc into multiple docs#37957

Closed
kapunahelewong wants to merge 1 commit into
angular:masterfrom
kapunahelewong:testing-phase1
Closed

docs: break testing doc into multiple docs#37957
kapunahelewong wants to merge 1 commit into
angular:masterfrom
kapunahelewong:testing-phase1

Conversation

@kapunahelewong

@kapunahelewong kapunahelewong commented Jul 7, 2020

Copy link
Copy Markdown
Contributor

This commit breaks up the testing document into nine total documents, with each document focusing on an existing section of the current testing documentation. There are no content changes. The only copy changes are those that reference other parts of the former testing guide. So, for example if a sentence previously referred to the section above but that section is now in a different doc the reference now goes to that document and the wording is changed appropriately.

This PR only breaks the document apart, and does not rewrite the content. The content is as close as possible to the original.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Now there are new documents where the original testing document used to be. The new documents are each one of the major sections from the original testing.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

https://pr37957-ca2700e.ngbuilds.io/guide/testing

@kapunahelewong kapunahelewong added feature Label used to distinguish feature request from other issues comp: docs action: review The PR is still awaiting reviews from at least one requested reviewer effort2: days risk: low labels Jul 7, 2020
@ngbot ngbot Bot modified the milestone: Backlog Jul 7, 2020
@mary-poppins

Copy link
Copy Markdown

You can preview fff04e2 at https://pr37957-fff04e2.ngbuilds.io/.

@gkalpak gkalpak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for fw-upgrade (with one minor comment) 👍

Reviewed-for: fw-upgrade

Comment thread aio/content/navigation.json Outdated
Comment thread aio/content/guide/upgrade-setup.md Outdated
@gkalpak gkalpak added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jul 7, 2020
@pullapprove pullapprove Bot requested a review from IgorMinar July 7, 2020 20:59
This commit breaks up the testing document into nine total documents, with each document focusing on an existing section of the current testing documentation. There are no content changes.
@mary-poppins

Copy link
Copy Markdown

You can preview ca2700e at https://pr37957-ca2700e.ngbuilds.io/.

@kapunahelewong kapunahelewong added the target: patch This PR is targeted for the next patch release label Jul 7, 2020

@aikithoughts aikithoughts left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you for the excellent commit message!

Reviewed-for: global-docs-approvers

@kapunahelewong kapunahelewong removed the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jul 8, 2020
@kapunahelewong kapunahelewong removed the request for review from IgorMinar July 8, 2020 16:31
@pullapprove pullapprove Bot requested a review from IgorMinar July 8, 2020 16:31
@aikithoughts aikithoughts requested review from jelbourn and removed request for IgorMinar July 8, 2020 16:50
@pullapprove pullapprove Bot requested a review from IgorMinar July 8, 2020 16:51

@jelbourn jelbourn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, using global approvers for codeowners

Reviewed-for: global-approvers

@jelbourn jelbourn removed the request for review from IgorMinar July 8, 2020 22:53
@jelbourn jelbourn added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Jul 8, 2020
atscott pushed a commit that referenced this pull request Jul 8, 2020
This commit breaks up the testing document into nine total documents, with each document focusing on an existing section of the current testing documentation. There are no content changes.

PR Close #37957
@atscott atscott closed this in bdbbff6 Jul 8, 2020
gkalpak added a commit to gkalpak/angular that referenced this pull request Jul 14, 2020
In angular#37957, parts of the testing guide were broken out into separate
guides. As part of that work, the `<live-example>` tags were also copied
to the new guides. These `<live-example>` tags did not specify the
targeted example project via the `name` attribute, thus they were
implicitly targeting the example with the same name as the guide they
were in. See the [Docs style guide][1] for more info.

However, there is only one example project (`testing/`) and all
`<live-example>` tags were supposed to target that. This worked fine on
the `testing.md` guide, but it broke on other guides (which tried to
target non-existing example projects based on their names).

This commit fixes it by explicitly specifying which example is targeted
by the `<live-example>` tags. It also removes the `embedded-style`
attribute that has no effect.

[1]: https://angular.io/guide/docs-style-guide#live-examples

Fixes angular#38036
atscott pushed a commit that referenced this pull request Jul 14, 2020
In #37957, parts of the testing guide were broken out into separate
guides. As part of that work, the `<live-example>` tags were also copied
to the new guides. These `<live-example>` tags did not specify the
targeted example project via the `name` attribute, thus they were
implicitly targeting the example with the same name as the guide they
were in. See the [Docs style guide][1] for more info.

However, there is only one example project (`testing/`) and all
`<live-example>` tags were supposed to target that. This worked fine on
the `testing.md` guide, but it broke on other guides (which tried to
target non-existing example projects based on their names).

This commit fixes it by explicitly specifying which example is targeted
by the `<live-example>` tags. It also removes the `embedded-style`
attribute that has no effect.

[1]: https://angular.io/guide/docs-style-guide#live-examples

Fixes #38036

PR Close #38038
atscott pushed a commit that referenced this pull request Jul 14, 2020
In #37957, parts of the testing guide were broken out into separate
guides. As part of that work, the `<live-example>` tags were also copied
to the new guides. These `<live-example>` tags did not specify the
targeted example project via the `name` attribute, thus they were
implicitly targeting the example with the same name as the guide they
were in. See the [Docs style guide][1] for more info.

However, there is only one example project (`testing/`) and all
`<live-example>` tags were supposed to target that. This worked fine on
the `testing.md` guide, but it broke on other guides (which tried to
target non-existing example projects based on their names).

This commit fixes it by explicitly specifying which example is targeted
by the `<live-example>` tags. It also removes the `embedded-style`
attribute that has no effect.

[1]: https://angular.io/guide/docs-style-guide#live-examples

Fixes #38036

PR Close #38038
@angular-automatic-lock-bot

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Aug 8, 2020
profanis pushed a commit to profanis/angular that referenced this pull request Sep 5, 2020
This commit breaks up the testing document into nine total documents, with each document focusing on an existing section of the current testing documentation. There are no content changes.

PR Close angular#37957
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker cla: yes effort2: days feature Label used to distinguish feature request from other issues risk: low target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants