From 33b85c30ae6c9dbe0b7196990750cf8707246175 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Wed, 9 Apr 2025 09:44:42 +0200 Subject: [PATCH 1/2] Add system path tip to local contribution guide This adds a tip after the tabbed steps to run `docs-builder` from anywhere. --- docs/contribute/locally.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/contribute/locally.md b/docs/contribute/locally.md index 9e4c844fd..4120d55ad 100644 --- a/docs/contribute/locally.md +++ b/docs/contribute/locally.md @@ -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} @@ -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 directory and add its path to the system paths to run it from any folder. On macOS, edit the paths file by running `sudo nano /etc/paths`. +::: + ## Clone a content repository [#step-two] :::{tip} From c48d9d9603fb0e235b91e2241caefc9d8c050329 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Wed, 9 Apr 2025 12:04:18 +0200 Subject: [PATCH 2/2] Update instructions for placing `docs-builder` binary --- docs/contribute/locally.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/locally.md b/docs/contribute/locally.md index 4120d55ad..81963a460 100644 --- a/docs/contribute/locally.md +++ b/docs/contribute/locally.md @@ -97,7 +97,7 @@ This guide uses the first option. If you'd like to clone the repository and buil :::: :::{tip} -Place the `docs-builder` binary file in a directory and add its path to the system paths to run it from any folder. On macOS, edit the paths file by running `sudo nano /etc/paths`. +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]