Skip to content

docs: fix live examples in testing guides#38038

Closed
gkalpak wants to merge 1 commit into
angular:masterfrom
gkalpak:fix-docs-testing-live-examples
Closed

docs: fix live examples in testing guides#38038
gkalpak wants to merge 1 commit into
angular:masterfrom
gkalpak:fix-docs-testing-live-examples

Conversation

@gkalpak

@gkalpak gkalpak commented Jul 14, 2020

Copy link
Copy Markdown
Member

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 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.

Fixes #38036.

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
@gkalpak gkalpak added type: bug/fix action: merge The PR is ready for merge by the caretaker comp: docs target: patch This PR is targeted for the next patch release labels Jul 14, 2020
@ngbot ngbot Bot modified the milestone: needsTriage Jul 14, 2020
@mary-poppins

Copy link
Copy Markdown

You can preview cfa7fbb at https://pr38038-cfa7fbb.ngbuilds.io/.

@gkalpak gkalpak marked this pull request as ready for review July 14, 2020 09:59
@pullapprove pullapprove Bot requested a review from AndrewKushnir July 14, 2020 09:59

@petebacondarwin petebacondarwin 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.

Reviewed-for: global-docs-approvers

@petebacondarwin petebacondarwin removed the request for review from AndrewKushnir July 14, 2020 10:07
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 atscott closed this in 9021d3f Jul 14, 2020
@gkalpak gkalpak deleted the fix-docs-testing-live-examples branch July 14, 2020 16:27
@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 14, 2020
profanis pushed a commit to profanis/angular that referenced this pull request Sep 5, 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

PR Close angular#38038
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 target: patch This PR is targeted for the next patch release type: bug/fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Links to StackBlitz example app and tests in testing guide broken

4 participants