2024-09-05 00:13:53 +00:00
|
|
|
# Documentation Site
|
2019-04-05 22:12:27 +00:00
|
|
|
|
|
|
|
|
## Developing And Testing
|
|
|
|
|
|
2024-09-05 00:13:53 +00:00
|
|
|
The [documentation website](https://argo-cd.readthedocs.io/) is built using `mkdocs` and `mkdocs-material`.
|
2019-04-05 22:12:27 +00:00
|
|
|
|
|
|
|
|
To test:
|
|
|
|
|
|
|
|
|
|
```bash
|
2019-10-21 23:54:23 +00:00
|
|
|
make serve-docs
|
2019-04-05 22:12:27 +00:00
|
|
|
```
|
2024-03-07 20:03:26 +00:00
|
|
|
Once running, you can view your locally built documentation at [http://0.0.0.0:8000/](http://0.0.0.0:8000/).
|
2024-09-05 00:13:53 +00:00
|
|
|
Making changes to documentation will automatically rebuild and refresh the view.
|
2024-03-07 20:03:26 +00:00
|
|
|
|
2024-03-09 13:12:48 +00:00
|
|
|
Before submitting a PR build the website, to verify that there are no errors building the site
|
2024-03-07 20:03:26 +00:00
|
|
|
```bash
|
|
|
|
|
make build-docs
|
|
|
|
|
```
|
2019-04-09 18:01:04 +00:00
|
|
|
|
2024-10-11 12:20:38 +00:00
|
|
|
If you want to build and test the site directly on your local machine without the use of docker container, follow the below steps:
|
|
|
|
|
|
2025-12-10 04:13:53 +00:00
|
|
|
1. Install the dependencies from the root of this repository using the `pip` command
|
2024-10-11 12:20:38 +00:00
|
|
|
```bash
|
2025-12-10 04:13:53 +00:00
|
|
|
pip install -r docs/requirements.txt
|
2024-10-11 12:20:38 +00:00
|
|
|
```
|
2025-12-10 04:13:53 +00:00
|
|
|
2. Build the docs site locally from the root
|
2024-10-11 12:20:38 +00:00
|
|
|
```bash
|
|
|
|
|
make build-docs-local
|
|
|
|
|
```
|
2025-12-10 04:13:53 +00:00
|
|
|
3. Start the docs site locally
|
2024-10-11 12:20:38 +00:00
|
|
|
```bash
|
|
|
|
|
make serve-docs-local
|
|
|
|
|
```
|
|
|
|
|
|
2019-04-05 22:12:27 +00:00
|
|
|
## Analytics
|
|
|
|
|
|
2025-09-21 23:46:10 +00:00
|
|
|
> [!TIP]
|
|
|
|
|
> Don't forget to disable your ad-blocker when testing.
|
2019-04-05 22:12:27 +00:00
|
|
|
|
2024-02-06 20:33:12 +00:00
|
|
|
We collect [Google Analytics](https://analytics.google.com/analytics/web/#/report-home/a105170809w198079555p192782995).
|