Skip to content

Commit

Permalink
docs: add missing documentation setup instructions (angular#48174)
Browse files Browse the repository at this point in the history
PR Close angular#48174
  • Loading branch information
Bob Watson authored and dylhunn committed Nov 22, 2022
1 parent 7fbb53f commit 2e2135b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
21 changes: 19 additions & 2 deletions aio/content/guide/doc-prepare-to-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ For more information about the required software, see [Setting up the local envi

Angular requires an [active long-term-support (LTS) or maintenance LTS version](https://nodejs.org/about/releases) of Node.js.

* [nvm](https://github.com/nvm-sh/nvm#about)
* [Yarn](https://yarnpkg.com/getting-started/install)
* [Homebrew](https://brew.sh) for macOS or [Chocolatey](https://chocolatey.org/install) for Windows
* [Vale][GithubAngularAngularTreeMainAioToolsDocLinterInstallValeOnYourDevelopmentSystemReadmeMd] \(see note\)
Expand Down Expand Up @@ -277,18 +278,34 @@ After you clone the origin repo on your local computer, run these commands from

<code-example format="shell" language="shell">

cd personal/angular/aio
cd personal/angular

</code-example>

1. Run this command to install the npm modules.
1. Run this command to install the Angular dependencies.

<code-example format="shell" language="shell">

yarn install

</code-example>

1. Run this command to navigate to the documentation project.

<code-example format="shell" language="shell">

cd aio

</code-example>

1. Run this command to install the npm modules for the documentation.

<code-example format="shell" language="shell">

yarn setup

</code-example>

1. Locate `angular/aio/tools/doc-linter/vale.ini` in your working directory to use in the next step as the path to the configuration file in the **Vale:Config** setting.

1. [Install Vale][GithubAngularAngularTreeMainAioToolsDocLinterInstallValeOnYourDevelopmentSystemReadmeMd] to complete the software installation.
Expand Down
2 changes: 2 additions & 0 deletions aio/ngsw-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,11 @@
"!/guide/set-document-title/{0,1}",
"!/guide/setup-systemjs-anatomy/{0,1}",
"!/guide/setup/{0,1}",
"!/guide/update-to-latest-version/{0,1}",
"!/guide/updating-to-version-10/{0,1}",
"!/guide/updating-to-version-11/{0,1}",
"!/guide/updating-to-version-12/{0,1}",
"!/guide/updating-to-version-13/{0,1}",
"!/guide/webpack/{0,1}",
"!/guide/{0,1}",
"!/news*",
Expand Down

0 comments on commit 2e2135b

Please sign in to comment.