Skip to content

Commit f4039ae

Browse files
authored
update contributor guide (#481)
* update contributor guide Signed-off-by: bmorelli25 <[email protected]> * add new uri Signed-off-by: bmorelli25 <[email protected]> * update guide * small fix Signed-off-by: bmorelli25 <[email protected]> --------- Signed-off-by: bmorelli25 <[email protected]>
1 parent abd28cf commit f4039ae

File tree

3 files changed

+58
-17
lines changed

3 files changed

+58
-17
lines changed

docs/contribute/index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,29 @@ Whether you're a technical writer or you've only edited Elastic docs once or twi
1010

1111
## Contribute to the docs [#contribute]
1212

13-
* Simple bugs and enhancements --> [Contribute on the web](on-the-web.md)
14-
* Complex or multi-page updates --> [Contribute locally](locally.md)
15-
* Test migrated content --> [Migration guide](../migration/guide/index.md)
13+
The version of the docs you want to contribute to determines the tool and syntax you must use to update the docs.
14+
15+
### Contribute to Elastic Stack version 8.x docs and earlier
16+
17+
To contribute to earlier versions of the Elastic Stack, you must work with our [legacy documentation build system](https://github.com/elastic/docs). This system uses AsciiDoc as it's authoring format.
18+
19+
* For **simple bugfixes and enhancements** --> [Contribute on the web](on-the-web.md)
20+
* For **complex or multi-page updates** --> See the [legacy documentation build guide](https://github.com/elastic/docs?tab=readme-ov-file#building-documentation)
21+
22+
### Contribute to Elastic Stack version 9.0 docs and later
23+
24+
* For **simple bugfixes and enhancements** --> [contribute on the web](on-the-web.md)
25+
* For **complex or multi-page updates** --> [Contribute locally](locally.md)
1626

1727
## Report a bug
1828

1929
* It's a **documentation** problem --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) *or* [Fix it myself](locally.md)
2030
* It's a **build tool (docs-builder)** problem --> [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
21-
* It's a **migration tooling** problem --> [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
2231

2332
## Request an enhancement
2433

2534
* Make the **documentation** better --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml)
26-
* Make our **build tool (docs-builder)** better --> [Open a docs-builder issue](https://github.com/elastic/docs-builder/issues/new?template=enhancement.yaml)
35+
* Make our **build tool (docs-builder)** better --> [Start a docs-builder discussion](https://github.com/elastic/docs-builder/discussions)
2736

2837
## Work on docs-builder
2938

docs/contribute/locally.md

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
11
# Contribute locally
22

33
Follow these steps to contribute to Elastic docs.
4+
5+
* [Prerequisites](#prerequisites)
46
* [Step 1: Install `docs-builder`](#step-one)
5-
* [Step 2: Clone the `docs-content` repository](#step-two)
7+
* [Step 2: Clone a content repository](#step-two)
68
* [Step 3: Serve the Documentation](#step-three)
7-
* [Step 4: Open a PR](#step-three)
9+
* [Step 4: Write docs!](#step-four)
10+
* [Step 5: Push your changes](#step-five)
11+
12+
## Prerequisites
13+
14+
To write and push updates to Elastic documentation, you need the following:
15+
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/)
819

920
## Step 1: Install `docs-builder` [#step-one]
1021

22+
There are two different ways to install and run `docs-builder`:
23+
24+
1. Download, extract, and run the binary (recommended)
25+
1. Clone the repository and build the binary from source
26+
27+
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).
28+
1129
::::{tab-set}
1230

1331
:::{tab-item} macOS
@@ -27,7 +45,7 @@ Follow these steps to contribute to Elastic docs.
2745
```
2846

2947
3. **Run the Binary:**
30-
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`:
48+
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`:
3149
```sh
3250
./docs-builder serve -p ./path/to/docs
3351
```
@@ -51,7 +69,7 @@ Follow these steps to contribute to Elastic docs.
5169
```
5270

5371
3. **Run the Binary:**
54-
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`:
72+
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`:
5573
```sh
5674
.\docs-builder serve -p ./path/to/docs
5775
```
@@ -75,7 +93,7 @@ Follow these steps to contribute to Elastic docs.
7593
```
7694

7795
3. **Run the Binary:**
78-
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`:
96+
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`:
7997
```sh
8098
./docs-builder serve -p ./path/to/docs
8199
```
@@ -84,22 +102,28 @@ Follow these steps to contribute to Elastic docs.
84102

85103
::::
86104

87-
## Clone the `docs-content` Repository [#step-two]
105+
## Clone a content repository [#step-two]
106+
107+
:::{tip}
108+
Documentation lives 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 lives.
109+
:::
88110

89-
Clone the `docs-content` repository to a directory of your choice:
111+
In this guide, we'll clone the [`docs-content`](https://github.com/elastic/docs-content) repository. The `docs-content` repository is the home for narrative documentation at Elastic. Clone this repo to a directory of your choice:
90112
```sh
91113
git clone https://github.com/elastic/docs-content.git
92114
```
93115

94116
## Serve the Documentation [#step-three]
95117

96-
1. **Navigate to the cloned repository:**
118+
1. **Navigate to the `docs-builder` clone location:**
97119
```sh
98120
cd docs-content
99121
```
100122

101-
2. **Run the Binary:**
102-
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`:
123+
1. **Run the Binary:**
124+
Run the binary with the `serve` command to build and serve the content set to http://localhost:3000. Specify the path to the `docset.yml` file that you want to build with `-p`.
125+
126+
For example, if `docs-builder` and `docs-content` are in the same top-level directory, you would run:
103127
```sh
104128
# macOS/Linux
105129
./docs-builder serve -p ./migration-test
@@ -110,9 +134,16 @@ git clone https://github.com/elastic/docs-content.git
110134

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

113-
## Step 4: Open a PR [#step-four]
137+
## Step 4: Write docs [#step-four]
138+
139+
We write docs in markdown. See 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 pizazz to your docs.
140+
141+
## Step 5: Push your changes [#step-five]
142+
143+
After you've made your changes locally,
114144

115-
Open a PR. Good luck.
145+
* [Push your commits](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository)
146+
* [Open a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
116147

117148
## Step 5: View on elastic.co/docs
118149

docs/docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ external_hosts:
2121
- github.io
2222
- github.com
2323
- elastic.dev
24+
- visualstudio.com
2425
exclude:
2526
- '_*.md'
2627
subs:

0 commit comments

Comments
 (0)