Skip to content

Extended diagnostics documentation#44704

Closed
dgp1130 wants to merge 3 commits intoangular:masterfrom
dgp1130:etd-doc
Closed

Extended diagnostics documentation#44704
dgp1130 wants to merge 3 commits intoangular:masterfrom
dgp1130:etd-doc

Conversation

@dgp1130
Copy link
Contributor

@dgp1130 dgp1130 commented Jan 12, 2022

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Documentation content changes
  • angular.io application / infrastructure changes

Refs #42966.

What is the new behavior?

Adds a new section for extended diagnostics to describe the feature as whole as well as subpages diving into each currently available diagnostic.

Does this PR introduce a breaking change?

  • No

Other information

Special thanks to @gkalpak for the docs-infra help! Couldn't have done this without you.

@dgp1130 dgp1130 added the target: minor This PR is targeted for the next minor release label Jan 12, 2022
@aikithoughts
Copy link
Contributor

@TMDavisGoogle Could you please do an editing pass on this content update? Thank you!

Copy link
Contributor

@TMDavisGoogle TMDavisGoogle left a comment

Choose a reason for hiding this comment

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

Light editing (phrasing, punctuation) done.

@dgp1130 dgp1130 force-pushed the etd-doc branch 2 times, most recently from e864b8d to a132c29 Compare January 13, 2022 00:59
@dgp1130
Copy link
Contributor Author

dgp1130 commented Jan 13, 2022

Thanks @TMDavisGoogle, applied your suggestions.

@dgp1130 dgp1130 requested a review from TMDavisGoogle January 13, 2022 01:01
Copy link
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

🎉

@dgp1130
Copy link
Contributor Author

dgp1130 commented Jan 14, 2022

I realized I forgot to mention that strictTemplates is required (and that certain extended diagnostics may have their own requirements). I added strictTemplates to the base doc and also added a "Configuration requirements" section for each check to explain what additional configuration it needs to run.

Refs angular#42966.

Look for changes in error docs (i.e. docs under `aio/content/error/`) in
`authors-package`, so that such docs are tracked when running the
`serve-and-sync` script.
@dgp1130 dgp1130 force-pushed the etd-doc branch 2 times, most recently from e008e66 to de49a39 Compare January 19, 2022 02:26
@dgp1130 dgp1130 added target: rc This PR is targeted for the next release-candidate and removed target: minor This PR is targeted for the next minor release labels Jan 20, 2022
gkalpak and others added 2 commits January 20, 2022 13:39
Refs angular#42966.

Look for changes in error docs (i.e. docs under `aio/content/error/`) in
`authors-package`, so that such docs are tracked when running the
`serve-and-sync` script.
This includes the initial documentation for extended diagnostics with a page for each of the two initial checks. They follow the same general formula, and hopefully in the future they can be properly generated from metadata rather than copy-pasted as they are currently.
Copy link
Contributor

@aikithoughts aikithoughts left a comment

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

@pullapprove pullapprove bot requested review from atscott, dylhunn and jelbourn January 24, 2022 16:09
Copy link
Contributor

@atscott atscott left a comment

Choose a reason for hiding this comment

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

reviewed-for: size-tracking

@pullapprove pullapprove bot requested a review from jessicajaniuk January 24, 2022 17:12
Copy link
Contributor

@jessicajaniuk jessicajaniuk left a comment

Choose a reason for hiding this comment

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

LGTM 🍪

reviewed-for: size-tracking

@dgp1130 dgp1130 added the action: merge The PR is ready for merge by the caretaker label Jan 24, 2022
@AndrewKushnir
Copy link
Contributor

This PR was merged into the repository by commit 33f23ab.

AndrewKushnir pushed a commit that referenced this pull request Jan 24, 2022
Refs #42966.

Look for changes in error docs (i.e. docs under `aio/content/error/`) in
`authors-package`, so that such docs are tracked when running the
`serve-and-sync` script.

PR Close #44704
AndrewKushnir pushed a commit that referenced this pull request Jan 24, 2022
Refs #42966.

Look for changes in error docs (i.e. docs under `aio/content/error/`) in
`authors-package`, so that such docs are tracked when running the
`serve-and-sync` script.

PR Close #44704
AndrewKushnir pushed a commit that referenced this pull request Jan 24, 2022
This includes the initial documentation for extended diagnostics with a page for each of the two initial checks. They follow the same general formula, and hopefully in the future they can be properly generated from metadata rather than copy-pasted as they are currently.

PR Close #44704
AndrewKushnir pushed a commit that referenced this pull request Jan 24, 2022
Refs #42966.

Look for changes in error docs (i.e. docs under `aio/content/error/`) in
`authors-package`, so that such docs are tracked when running the
`serve-and-sync` script.

PR Close #44704
AndrewKushnir pushed a commit that referenced this pull request Jan 24, 2022
This includes the initial documentation for extended diagnostics with a page for each of the two initial checks. They follow the same general formula, and hopefully in the future they can be properly generated from metadata rather than copy-pasted as they are currently.

PR Close #44704
@dgp1130 dgp1130 deleted the etd-doc branch January 24, 2022 20:45
@angular-automatic-lock-bot
Copy link

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 Feb 24, 2022
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 target: rc This PR is targeted for the next release-candidate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants