docs: initial upload of styles used by doc linter - #46897
bob-watson wants to merge 1 commit into
Conversation
bob-watson
added
comp: docs
action: review
bob-watson
removed
the
action: review
|
You can preview d22e60d at https://pr46897-d22e60d.ngbuilds.io/. |
gkalpak
left a comment
gkalpak
left a comment
There was a problem hiding this comment.
A couple of comments that probably need addressing and a few optional suggestions.
BTW, you can ensure VSCode will show the vale extension as recommended for the workspace when people open the angular/angular repo, by adding it in .vscode/extensions.json (or leave it commented out at the bottom of the list if it's only useful when working with docs inside the aio/ directory):
"recommendations": [
"devondcarew.bazel-code",
"gkalpak.aio-docs-utils",
"ms-vscode.vscode-typescript-tslint-plugin",
"xaver.clang-format",
// The following extensions are useful when working on angular.io (i.e. inside the `aio/` directory).
//"angular.ng-template",
//"dbaeumer.vscode-eslint",
+ //"errata-ai.vale-server",
],
|
You can preview e326d94 at https://pr46897-e326d94.ngbuilds.io/. |
|
Thanks for the notes! |
|
You can preview 90a3123 at https://pr46897-90a3123.ngbuilds.io/. |
|
You can preview f7dd117 at https://pr46897-f7dd117.ngbuilds.io/. |
|
You can preview afade27 at https://pr46897-afade27.ngbuilds.io/. |
gkalpak
left a comment
gkalpak
left a comment
There was a problem hiding this comment.
Basically, one last issue regarding git workspace. Otherwise lgtm 🎉
FYI, while the commit messages follow the commit message guidelines, having separate commits for addressing review comments is against the spirit of the guidelines. I.e. all commits should be self-contained. For example, for this PR all changes could be part of one commit, sine they are all implementing the addition of the doc linter.
This is not terribly important for docs commits, because those do not end up in the auto-generated changelog. But it does affect the readability of the commit history and makes it more difficult to find out when a particular change was introduced (and why/what is the context). To be clear, it does to remove anything from our ability to read history and find out these things - it just makes it less easy.
BTW, there is currently a mechanism for adding new commits to address review feedback (which makes it easier for the reviewer) while at the same time ensuring that all changes will be combined into one commit when the PR is merged into the target branch: fixup commits
However, they are less straight-forward (especially if you are not using the git CLI or a git UI that supports this feature).
This is not necessarily a blocker. I just wanted to bring it up.
(BTW, happy to elaborate more on any points that are not clear.)
gkalpak
added
the
action: cleanup
Add the configuration and style files to support documentation linting. The `README.md` file includes instructions for installation and use of the lint tool.
|
You can preview 36464ea at https://pr46897-36464ea.ngbuilds.io/. |
bob-watson
added
action: merge
|
This PR was merged into the repository by commit bfddfe5. |
Add the configuration and style files to support documentation linting. The `README.md` file includes instructions for installation and use of the lint tool. PR Close #46897
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
4 participants
This PR replaces PR #46854 and includes the edits to the comments from that PR.
Adds styles and configuration files for contributors to use the Vale documentation linter in their IDE while they edit angular.io topics.
This PR includes documentation for using the documentation linter in the README.md file.
This PR does not alter any angular.io or other published documentation.
This PR is going to cause problems with the inclusive language CI test because it includes files with all the prohibited words in its tests to look for those words in the documentation.
These seem to be only two files: