diff options
| -rw-r--r-- | doc/setup.md | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/doc/setup.md b/doc/setup.md index 5d7a295f..80521e36 100644 --- a/doc/setup.md +++ b/doc/setup.md @@ -167,8 +167,7 @@ To commit and push changes: ### `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 site. To resolve this error, run: +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 site. To resolve this error, run: ```shell make clone-all-docs-projects @@ -176,8 +175,7 @@ make clone-all-docs-projects ### `requires ruby version >= 2.7.0, which is incompatible with the current version, ruby 2.6.8p205` -You can encounter this error when running `make setup`, even though you installed the required Ruby version with `asdf`. It usually -means that your shell is pointing to the wrong Ruby installation. macOS comes with versions of Ruby that are too old for `gitlab-docs`. +You can encounter this error when running `make setup`, even though you installed the required Ruby version with `asdf`. It usually means that your shell is pointing to the wrong Ruby installation. macOS comes with versions of Ruby that are too old for `gitlab-docs`. ```shell # check system Ruby version @@ -190,9 +188,7 @@ means that your shell is pointing to the wrong Ruby installation. macOS comes wi The system and asdf versions of Ruby are likely to match the versions in the error. To solve this error, you must configure your shell to point to the `asdf` version instead of the system version. -1. Check the [install `asdf`](https://asdf-vm.com/guide/getting-started.html#_3-install-asdf) instructions, and make sure you used the method - that matches the way you [downloaded `asdf`](https://asdf-vm.com/guide/getting-started.html#_2-download-asdf) and the shell you use. If you - didn't use the matching instructions, perform the required steps. +1. Check the [install `asdf`](https://asdf-vm.com/guide/getting-started.html#_3-install-asdf) instructions, and make sure you used the method that matches the way you [downloaded `asdf`](https://asdf-vm.com/guide/getting-started.html#_2-download-asdf) and the shell you use. If you didn't use the matching instructions, perform the required steps. 1. Check that `asdf` is configured in your shell's configuration as specified in the asdf instructions. For example, if you use ZSH: ```shell @@ -206,6 +202,17 @@ to the `asdf` version instead of the system version. ruby --version ``` +### `An error occurred while installing eventmachine (1.2.7), and Bundler cannot continue` + +You can encounter this error if you run `make view` and don't have OpenSSL installed on your machine. To resolve this error: + +1. Install OpenSSL with the `brew install openssl` command (you'll need to install [Brew](https://brew.sh/), if you don't already have it). +1. Run the command: + + ```plaintext + gem install eventmachine -- --with-openssl-dir=/usr/local/opt/openssl@1.1 + ``` + ### `Address already in use - bind(2) for 127.0.0.1:3000` You can encounter this error if you run `make view` whilst running the [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/index.md) server on the same port, which is `3000` in this example. |