Skip to content

Commit ed4f058

Browse files
authored
Add some troubleshooting instructions (#1230)
This adds some troubleshooting instructions to the docs-builder install doc.
1 parent 12e21d4 commit ed4f058

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/contribute/locally.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ This guide uses the first option. If you'd like to clone the repository and buil
3737
```sh
3838
sudo curl -L https://raw.githubusercontent.com/elastic/docs-builder/refs/heads/main/install.sh | sh
3939
```
40+
4041
This downloads the latest binary, makes it executable, and installs it to your user PATH.
4142

4243
2. **Run docs-builder from a docs folder**
@@ -47,7 +48,9 @@ This guide uses the first option. If you'd like to clone the repository and buil
4748
docs-builder serve
4849
```
4950

50-
To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
51+
To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
52+
53+
If you get a `Permission denied` error, make sure that you aren't trying to run a directory instead of a file. Also, grant the binary file execution permissions using `chmod +x docs-builder`.
5154

5255
:::
5356

@@ -76,9 +79,7 @@ To download and install the binary file manually, refer to [Releases](https://gi
7679
:::
7780
::::
7881

79-
:::{tip}
80-
Place the `docs-builder` binary file in a system path so that you can run it from any folder. On macOS, you can do this by running `sudo mv docs-builder /usr/local/bin/docs-builder`.
81-
:::
82+
8283

8384
## Clone a content repository [#step-two]
8485

0 commit comments

Comments
 (0)