diff options
| -rw-r--r-- | doc/setup.md | 28 |
1 files changed, 23 insertions, 5 deletions
diff --git a/doc/setup.md b/doc/setup.md index 42e6bff6..0593864c 100644 --- a/doc/setup.md +++ b/doc/setup.md @@ -48,13 +48,31 @@ they can be previewed. ## Preview GitLab Docs -To preview GitLab Docs locally, run the following in the checkout of `gitlab-docs`: +To preview GitLab Docs locally: -```shell -make view -``` +1. Run the following in the checkout of `gitlab-docs`: + + ```shell + make view + ``` + + The preview loads in your terminal. When the preview has finished loading, + your terminal outputs the following or something similar: + + ```shell + INFO: Starting GitLab documentation site... + View the site at http://127.0.0.1:3000/ + ``` + +1. To open your preview, go to the URL from your terminal output in your browser. + For this example, go to `http://127.0.0.1:3000/`. + +1. From your preview homepage, use the docs site navigation to go to the page you + want to preview. + + Do not use the search box, as search results take you to the live docs site. -If you make changes to any of the documentation in any of the documentation projects, rerun `make view` to see an +1. If you make changes to any of the documentation in any of the documentation projects, rerun `make view` to see an updated preview. ### Preview on mobile |