Skip to content

Commit 64defe5

Browse files
correct few sections and do minor edits (#1521)
1 parent ef8c009 commit 64defe5

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

docs/contribute/locally.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
# Contribute locally
22

3-
Follow these steps to contribute to Elastic docs.
4-
5-
* [Prerequisites](#prerequisites)
6-
* [Install `docs-builder`](#install-docs-builder)
7-
* [Clone a content repository](#clone-content)
8-
* [Build the docs](#build-the-docs)
9-
* [Write the docs](#write-docs)
10-
* [Push your changes](#push-changes)
3+
This document describes the process to set up Elastic documentation repositories locally, enabling you to contribute effectively.
114

125
## Prerequisites [#prerequisites]
136

147
To write and push updates to Elastic documentation, you need the following:
158

16-
1. **A code editor**: we recommend [Visual Studio Code](https://code.visualstudio.com/download)
17-
1. **Git installed on your machine**: learn how [here](https://github.com/git-guides/install-git)
18-
1. **A GitHub account**: sign up [here](https://github.com/)
9+
* **A code editor**: We recommend [Visual Studio Code](https://code.visualstudio.com/download)
10+
* **Git installed on your machine**: To install Git, see [How to install Git](https://github.com/git-guides/install-git)
11+
* **A GitHub account**: Sign up for an account on [Github](https://github.com/)
1912

2013
## Install `docs-builder` [#install-docs-builder]
2114

@@ -24,7 +17,7 @@ There are two different ways to install and run `docs-builder`:
2417
1. Download, extract, and run the binary (recommended).
2518
1. Clone the repository and build the binary from source.
2619

27-
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).
20+
This guide follows 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).
2821

2922
:::::{tab-set}
3023

@@ -38,18 +31,17 @@ This guide uses the first option. If you'd like to clone the repository and buil
3831
curl -sL https://ela.st/docs-builder-install | sh
3932
```
4033

41-
This downloads the latest binary, makes it executable, and installs it to your user PATH.
34+
This downloads the latest binary to `/usr/local/bin`, makes it an executable, and installs it to your user PATH. This means you can use the `docs-builder` command from any location of your machine to deploy and run documentation repositories like `docs-builder`, `docs-content` and so on.
35+
4236
You can optionally specify a specific version to install:
4337

4438
```sh
4539
DOCS_BUILDER_VERSION=0.40.0 curl -sL https://ela.st/docs-builder-install | sh
4640
```
4741

48-
To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
49-
5042
2. **Run docs-builder from a docs folder**
5143

52-
Use the `serve` command from any docs folder to start serving the documentation at [http://localhost:3000](http://localhost:3000):
44+
Use the `serve` command from any `docs` folder to start serving the documentation at [http://localhost:3000](http://localhost:3000):
5345

5446
```sh
5547
docs-builder serve
@@ -101,18 +93,18 @@ If you get a `Permission denied` error, make sure that you aren't trying to run
10193
## Clone a content repository [#clone-content]
10294

10395
:::{tip}
104-
Documentation is hosted in many repositories across Elastic. If you're unsure which repository to clone, you can use the **Edit this page** link on any documentation page to determine where the source file is hosted.
96+
Documentation is hosted in many repositories across Elastic. If you're unsure which repository to clone, you can use the **Edit this page** link on any documentation page to determine the location of the source file.
10597
:::
10698

107-
In this guide, we'll clone the [`docs-content`](https://github.com/elastic/docs-content) repository. The `docs-content` repository is the home for most narrative documentation at Elastic. Clone this repo to a directory of your choice:
99+
Clone the [`docs-content`](https://github.com/elastic/docs-content) repository to a directory of your choice. The `docs-content` repository is the home for most narrative documentation at Elastic.
108100

109101
```sh
110102
git clone https://github.com/elastic/docs-content.git
111103
```
112104

113105
## Write the docs [#write-docs]
114106

115-
We write docs in Markdown. Refer to our [syntax](../syntax/index.md) guide for the flavor of Markdown that we support and all of our custom directives that enable you to add a little extra pizzazz to your docs.
107+
We write docs in Markdown. Refer to our [syntax](../syntax/index.md) guide for the flavor of Markdown we support and all of our custom directives that enable you to add a little extra pizzazz to your docs.
116108

117109
This documentation is **cumulative**. This means that a new set of docs is not published for every minor release. Instead, each page stays valid over time and incorporates version-specific changes directly within the content. [Learn how to write cumulative documentation](cumulative-docs.md).
118110

@@ -121,13 +113,13 @@ This documentation is **cumulative**. This means that a new set of docs is not p
121113

122114
## Build the docs
123115

124-
Before pushing your changes, check that your changes build successfully.
116+
Before pushing your changes, verify all of them locally .
125117

126118
```
127119
docs-builder
128120
```
129121

130-
The build process informs you of any critical errors or warnings. It also shows less critical issues as Hints. Make sure not to introduce any new build errors, warnings, or hints.
122+
The build process informs you of any critical errors or warnings. It also shows less critical issues as Hints. Make sure you don't introduce any new build errors, warnings, or hints.
131123

132124
## Push your changes [#push-changes]
133125

@@ -164,14 +156,14 @@ For example:
164156
:::{tab-item} macOS & Linux
165157

166158
```sh
167-
docs-builder serve -p ./migration-test
159+
docs-builder serve
168160
```
169161
:::
170162

171163
:::{tab-item} Windows
172164

173165
```powershell
174-
docs-builder serve -p .\migration-test
166+
docs-builder serve -p .\docs-content
175167
```
176168
:::
177169
::::

0 commit comments

Comments
 (0)