Skip to content

Commit

Permalink
docs: update Vale installation instructions (#47031)
Browse files Browse the repository at this point in the history
This update includes:
* installation directions for the current version of the Vale VSCode extension (v. 0.15.0)
* a workaround for if the current version of the extension doesn't work.

PR Close #47031
  • Loading branch information
Bob Watson authored and dylhunn committed Aug 4, 2022
1 parent 3ee883e commit d0f4f1d
Showing 1 changed file with 31 additions and 13 deletions.
44 changes: 31 additions & 13 deletions aio/tools/doc-linter/README.md
Expand Up @@ -21,7 +21,7 @@ While Vale helps, it doesn't replace the reviewers that you're currently using t
1. [Install Vale][AioToolsDocLinterReadmeInstallValeInYourVsCodeIde] in your Visual Studio Code IDE.
To install and use Vale in a different IDE, see [Installation][ValeDocsValeCliInstallation].
2. Fix the problems that Vale identifies in your IDE.

Log any problem you encounter with the documentation linter as a [new docs issue][GithubAngularAngularIssuesNewAssigneesLabelsTemplate3DocsBugYaml] in the repo.
Be sure to specify that this is a linter issue in your description.

Expand Down Expand Up @@ -117,7 +117,7 @@ When necessary, you can apply these exceptions to your content.
A *style exception* allows you to exclude text from an individual style test.

To apply a style exception, surround the text that you do not want the linter to test with these HTML
`comment` elements. Between these comments, the linter ignores the style test in the comment, but
`comment` elements. Between these comments, the linter ignores the style test in the comment, but
still tests for all other styles that are in use.

```markdown
Expand Down Expand Up @@ -161,11 +161,11 @@ For more information, or to install Vale in another IDE or on another operating

Before you proceed, make sure that:

1. You have cloned the [`angular/angular` repo][GithubAngularAngular] on your system. You can work in a fork of the `angular/angular` repo,
1. You have cloned the [`angular/angular` repo][GithubAngularAngular] on your system. You can work in a fork of the `angular/angular` repo,
but it's easier if your Vale installation uses an up-to-date clone of the `angular/angular` repo.
2. You have a development or writing environment for `angular.io` in the `angular/angular` repo and you can build the `angular.io` docs.
For information about how to create the authoring environment for `angular.io`, see [Angular documentation project][GithubAngularAngularTreeMainAioAngularDocumentationProjectHttpsangulario].
3. You have the required package manager installed on your system. If not, install it before continuing.
3. You have the required package manager installed on your system. If not, install it before continuing.
* [homebrew][BrewMain] on your macOS system.
* [chocolatey][Chocolatey] on your Windows system.

Expand Down Expand Up @@ -246,18 +246,37 @@ To install Vale in a different IDE, see [Installation][ValeDocsValeCliInstallati
* On Windows, in the **File** menu, choose **Preferences**, and then choose **Settings**.
4. In the **User** settings, navigate to **Extensions > Vale**.
5. Update the Vale extension settings as shown.
* **Vale > Core : Use CLI**, checked.
* **Vale > Server : Lint Context**, `0`.
* **Vale > Server : Provide Fixes**, unchecked.
* **Vale > Server : Server URL**, leave empty.
* **Vale > Vale CLI : Config**, enter the full path to `vale.ini` from the preceding procedure and append the `vale.ini` filename.
* **Vale > Vale CLI : Min Alert Level**, choose `inherited` or `suggestion`.
* **Vale > Vale CLI : Path**, enter the full path of the `vale` application that `which vale` or `where vale.exe` returned in a preceding step.
* **Vale : Config**, enter the full path to `vale.ini` from the preceding procedure and append the `vale.ini` filename.
* **Vale : Min Alert Level**, choose `inherited` or `suggestion`.
* **Vale : Path**, enter the full path of the `vale` application that `which vale` or `where vale.exe` returned in a preceding step.
6. Restart Visual Studio Code to apply the new settings.

<!-- vale Angular.Angular_CliReference = YES -->
<!-- vale Angular.WriteGood_Illusions = YES -->

### Known issues with the Visual Studio Code extension

If you're having problems with the `0.15.0` version of the Vale extension to Visual Studio Code, try:

1. Uninstalling version `0.15.0` of the Vale extension.
2. Installing version `0.14.2` of the Vale extension.

If you're using version `0.14.2`, the Vale extension settings to use are:

<!-- vale Angular.WriteGood_Illusions = NO -->
<!-- vale Angular.Angular_CliReference = NO -->

* **Vale > Core : Use CLI**, checked.
* **Vale > Server : Lint Context**, `0`.
* **Vale > Server : Provide Fixes**, unchecked.
* **Vale > Server : Server URL**, leave empty.
* **Vale > Vale CLI : Config**, enter the full path to `vale.ini` from the preceding procedure and append the `vale.ini` filename.
* **Vale > Vale CLI : Min Alert Level**, choose `inherited` or `suggestion`.
* **Vale > Vale CLI : Path**, enter the full path of the `vale` application that `which vale` or `where vale.exe` returned in a preceding step.

<!-- vale Angular.Angular_CliReference = YES -->
<!-- vale Angular.WriteGood_Illusions = YES -->

## Update the Vale command-line tool

* To update Vale on macOS to the latest version, in your command-line tool, run `brew upgrade vale`.
Expand Down Expand Up @@ -300,5 +319,4 @@ If you're using another branch or fork of the `angular/angular` repo, be sure to

<!-- end links -->

<!-- @reviewed 2022-07-15 -->

<!-- @reviewed 2022-07-15 -->

0 comments on commit d0f4f1d

Please sign in to comment.