diff options
author | Kati Paizee <kpaizee@gitlab.com> | 2022-12-02 18:11:38 +0300 |
---|---|---|
committer | Sarah German <sgerman@gitlab.com> | 2022-12-02 18:11:38 +0300 |
commit | 8e11f7e1022560fd6fe03573973289101921cb41 (patch) | |
tree | f8bb2686332d78247ade920bbb36ce882b2f248a /doc | |
parent | 9fd5576a942ae9563e311e4db04088bc2014247a (diff) |
Add step to run make setup to troubleshooting
Diffstat (limited to 'doc')
-rw-r--r-- | doc/setup.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/setup.md b/doc/setup.md index 87c2c5da..15aa2ecc 100644 --- a/doc/setup.md +++ b/doc/setup.md @@ -163,6 +163,17 @@ To commit and push changes: ## Troubleshooting +### Dependency errors when running `make view` + +When running `make view`, you might get an error about a missing tool or dependency. +For example, you might need a new version of Ruby. + +To install and update the dependencies needed to preview docs locally, run: + +```shell +make setup +``` + ### `realpath: No such file or directory @ rb_check_realpath_internal` If you run into this error, it means you're missing one of the projects `gitlab-docs` relies on to build the content of the GitLab Docs site. |