Skip to content

[Fix] Clarify path specification for the serve command #1298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2025
Merged

[Fix] Clarify path specification for the serve command #1298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/contribute/locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,12 @@ This guide uses the first option. If you'd like to clone the repository and buil

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

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

```sh
docs-builder serve
```
The path to the `docset.yml` file that you want to build can be specified with `-p`.

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

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

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

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

```sh
docs-builder serve
```

The path to the `docset.yml` file that you want to build can be specified with `-p`.
:::
::::

Expand Down Expand Up @@ -111,7 +112,7 @@ cd docs-content

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

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`.
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`.

For example:

Expand Down
Loading