Contribute locally

Follow these steps to contribute to Elastic docs.

Step 1: Install docs-builder
Step 2: Clone the docs-content repository
Step 3: Serve the Documentation
Step 4: Open a PR

Step 1: Install `docs-builder` ¶

macOS

macOS¶

Download the Binary:
Download the latest macOS binary from releases:

		curl -LO https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-mac-arm64.zip

	

Extract the Binary:
Unzip the downloaded file:
```
unzip docs-builder-mac-arm64.zip
```
Run the Binary:
Use the serve command to start serving the documentation at http://localhost:3000. The path to the docset.yml file that you want to build can be specified with -p:
```
./docs-builder serve -p ./path/to/docs
```

Windows

Windows¶

Download the Binary:
Download the latest Windows binary from releases:

		Invoke-WebRequest -Uri https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-win-x64.zip -OutFile docs-builder-win-x64.zip

	

Extract the Binary:
Unzip the downloaded file. You can use tools like WinZip, 7-Zip, or the built-in Windows extraction tool.
```
Expand-Archive -Path docs-builder-win-x64.zip -DestinationPath .
```
Run the Binary:
Use the serve command to start serving the documentation at http://localhost:3000. The path to the docset.yml file that you want to build can be specified with -p:
```
.\docs-builder serve -p ./path/to/docs
```

Linux

Linux¶

Download the Binary:
Download the latest Linux binary from releases:

		wget https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-linux-x64.zip

	

Extract the Binary:
Unzip the downloaded file:
```
unzip docs-builder-linux-x64.zip
```
Run the Binary:
Use the serve command to start serving the documentation at http://localhost:3000. The path to the docset.yml file that you want to build can be specified with -p:
```
./docs-builder serve -p ./path/to/docs
```

Clone the `docs-content` Repository ¶

Clone the docs-content repository to a directory of your choice:

git clone https://github.com/elastic/docs-content.git

Serve the Documentation ¶

Navigate to the cloned repository:
```
cd docs-content
```
Run the Binary:
Use the serve command to start serving the documentation at http://localhost:3000. The path to the docset.yml file that you want to build can be specified with -p:
```
# macOS/Linux
./docs-builder serve -p ./migration-test

# Windows
.\docs-builder serve -p .\migration-test
```

Now you should be able to view the documentation locally by navigating to http://localhost:3000.

Step 4: Open a PR ¶

Open a PR. Good luck.

Step 5: View on elastic.co/docs¶

soon...