Skip to content

Add system path tip to local contribution guide #1064

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
Apr 9, 2025
Merged

Add system path tip to local contribution guide #1064

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33b85c3
Add system path tip to local contribution guide
theletterf Apr 9, 2025
c48d9d9
Update instructions for placing `docs-builder` binary
theletterf Apr 9, 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
10 changes: 7 additions & 3 deletions docs/contribute/locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ To write and push updates to Elastic documentation, you need the following:

There are two different ways to install and run `docs-builder`:

1. Download, extract, and run the binary (recommended)
1. Clone the repository and build the binary from source
1. Download, extract, and run the binary (recommended).
1. Clone the repository and build the binary from source.

This guide uses option one. If you'd like to clone the repository and build from source, learn how in the [project readme](https://github.com/elastic/docs-builder?tab=readme-ov-file#docs-builder).
This guide uses the first option. If you'd like to clone the repository and build from source, learn how in the [project readme](https://github.com/elastic/docs-builder?tab=readme-ov-file#docs-builder).

::::{tab-set}

Expand Down Expand Up @@ -96,6 +96,10 @@ This guide uses option one. If you'd like to clone the repository and build from

::::

:::{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]

:::{tip}
Expand Down
Loading