Skip to content

Commit bf9dfd6

Browse files
Clarify path specification for the serve command (#1298)
1 parent beba787 commit bf9dfd6

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/contribute/locally.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,12 @@ This guide uses the first option. If you'd like to clone the repository and buil
4444

4545
2. **Run docs-builder from a docs folder**
4646

47-
Use the `serve` command from any docs folder 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`:
47+
Use the `serve` command from any docs folder to start serving the documentation at http://localhost:3000:
4848

4949
```sh
5050
docs-builder serve
5151
```
52+
The path to the `docset.yml` file that you want to build can be specified with `-p`.
5253

5354
To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
5455

@@ -72,12 +73,12 @@ If you get a `Permission denied` error, make sure that you aren't trying to run
7273

7374
2. **Run docs-builder from a docs folder**
7475

75-
Use the `serve` command from any docs folder 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`:
76+
Use the `serve` command from any docs folder to start serving the documentation at http://localhost:3000:
7677

7778
```sh
7879
docs-builder serve
7980
```
80-
81+
The path to the `docset.yml` file that you want to build can be specified with `-p`.
8182
:::
8283
::::
8384

@@ -111,7 +112,7 @@ cd docs-content
111112

112113
:::::{step} Run docs-builder
113114

114-
Run the `docs-builder` 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`.
115+
Run the `docs-builder` binary with the `serve` command to build and serve the content set to http://localhost:3000. If necessary, specify the path to the `docset.yml` file that you want to build with `-p`.
115116

116117
For example:
117118

0 commit comments

Comments
 (0)