Skip to content

Commit

Permalink
add docs to build site locally (#20342)
Browse files Browse the repository at this point in the history
Signed-off-by: nitishfy <justnitish06@gmail.com>
  • Loading branch information
nitishfy authored Oct 11, 2024
1 parent 29c59ab commit ed311fe
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/developer-guide/contributors-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ make start-local ARGOCD_GPG_ENABLED=false

## Making Changes

### Docs Changes

Modifying the docs auto-reloads the changes on the [documentation website](https://argo-cd.readthedocs.io/) that can be locally built using `make serve-docs` command.
Once running, you can view your locally built documentation on port 8000.

Read more about this [here](https://argo-cd.readthedocs.io/en/latest/developer-guide/docs-site/).

### UI Changes

Modifying the User-Interface (by editing .tsx or .scss files) auto-reloads the changes on port 4000.
Expand Down
19 changes: 19 additions & 0 deletions docs/developer-guide/docs-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,25 @@ Before submitting a PR build the website, to verify that there are no errors bui
make build-docs
```

If you want to build and test the site directly on your local machine without the use of docker container, follow the below steps:

1. Install the `mkdocs` using the `pip` command
```bash
pip install mkdocs
```
2. Install the required dependencies using the below command
```bash
pip install $(mkdocs get-deps)
```
3. Build the docs site locally from the root
```bash
make build-docs-local
```
4. Start the docs site locally
```bash
make serve-docs-local
```

## Analytics

!!! tip
Expand Down

0 comments on commit ed311fe

Please sign in to comment.