Skip to content

Add some troubleshooting instructions #1230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2025
Merged

Add some troubleshooting instructions #1230

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
102fb87
Add some troubleshooting instructions
theletterf May 9, 2025
d1c3965
Merge branch 'main' into theletterf-patch-1
theletterf May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/contribute/locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ This guide uses the first option. If you'd like to clone the repository and buil
```sh
sudo curl -L https://raw.githubusercontent.com/elastic/docs-builder/refs/heads/main/install.sh | sh
```

This downloads the latest binary, makes it executable, and installs it to your user PATH.

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

To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.

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`.

:::

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

:::{tip}
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`.
:::


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

Expand Down
Loading