mirror of
https://github.com/argoproj/argo-cd
synced 2026-05-24 09:50:08 +00:00
4a4db1d9ca
Signed-off-by: emirot <emirot.nolan@gmail.com> Co-authored-by: Nitish Kumar <justnitish06@gmail.com>
40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# Documentation Site
|
|
|
|
## Developing And Testing
|
|
|
|
The [documentation website](https://argo-cd.readthedocs.io/) is built using `mkdocs` and `mkdocs-material`.
|
|
|
|
To test:
|
|
|
|
```bash
|
|
make serve-docs
|
|
```
|
|
Once running, you can view your locally built documentation at [http://0.0.0.0:8000/](http://0.0.0.0:8000/).
|
|
Making changes to documentation will automatically rebuild and refresh the view.
|
|
|
|
Before submitting a PR build the website, to verify that there are no errors building the site
|
|
```bash
|
|
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 dependencies from the root of this repository using the `pip` command
|
|
```bash
|
|
pip install -r docs/requirements.txt
|
|
```
|
|
2. Build the docs site locally from the root
|
|
```bash
|
|
make build-docs-local
|
|
```
|
|
3. Start the docs site locally
|
|
```bash
|
|
make serve-docs-local
|
|
```
|
|
|
|
## Analytics
|
|
|
|
> [!TIP]
|
|
> Don't forget to disable your ad-blocker when testing.
|
|
|
|
We collect [Google Analytics](https://analytics.google.com/analytics/web/#/report-home/a105170809w198079555p192782995).
|