diff options
| author | Mike Jang <mjang@gitlab.com> | 2020-03-25 20:52:52 +0300 |
|---|---|---|
| committer | Mike Jang <mjang@gitlab.com> | 2020-03-25 20:52:52 +0300 |
| commit | b5a3556df0299f7969e0c4e0e9cfab409b314d3a (patch) | |
| tree | e58aec52b5e1ecd9466cca1bd17e8cb986d556a5 /README.md | |
| parent | fb5a9335956fe3acbede21b27d76cb6d0c4879e7 (diff) | |
Clarify doc build instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 10 insertions, 9 deletions
@@ -124,14 +124,6 @@ Install [yarn](https://yarnpkg.com/en/docs/install), a package manager for the N Check your Yarn version with `yarn -v`. -### Install node dependencies - -1. Install node dependences in the `node_modules` folder: - - ```shell - yarn install - ``` - ## Install Nanoc's dependencies Now let's make Bundler deal with the dependencies defined in the @@ -241,15 +233,24 @@ the directory that holds the documentation content. 1. Check if the symlinks were successfully created: ```shell + cd dev/gitlab/gitlab-docs ls -la content/ ``` -If they're there, we're good to go! +If they're there, we're almost good to go! **Note:** You can use the `pwd` command when in the terminal to check the directory path you are currently in and use that output to use with the symlinks commands above. +### Install node dependencies + +1. Install node dependences in the `gitlab-docs/node_modules` folder: + + ```shell + yarn install + ``` + ## Preview the Docs website Run the following command to bring the embedded web server up: |