Fix local guide for building and testing docs (#19785)

Signed-off-by: todaywasawesome <dan@codefresh.io>
This commit is contained in:
Dan Garfield
2024-09-04 18:13:53 -06:00
committed by GitHub
parent 1028808bb7
commit 9c47a709fb
6 changed files with 9 additions and 9 deletions

View File

@@ -553,7 +553,7 @@ build-docs-local:
.PHONY: build-docs
build-docs:
$(DOCKER) run ${MKDOCS_RUN_ARGS} --rm -it -v ${CURRENT_DIR}:/docs -w /docs --entrypoint "" ${MKDOCS_DOCKER_IMAGE} sh -c 'pip install -r docs/requirements.txt; mkdocs build'
$(DOCKER) run ${MKDOCS_RUN_ARGS} --rm -it -v ${CURRENT_DIR}:/docs -w /docs --entrypoint "" ${MKDOCS_DOCKER_IMAGE} sh -c 'pip install mkdocs; pip install $$(mkdocs get-deps); mkdocs build'
.PHONY: serve-docs-local
serve-docs-local:
@@ -561,7 +561,7 @@ serve-docs-local:
.PHONY: serve-docs
serve-docs:
$(DOCKER) run ${MKDOCS_RUN_ARGS} --rm -it -p 8000:8000 -v ${CURRENT_DIR}:/docs -w /docs --entrypoint "" ${MKDOCS_DOCKER_IMAGE} sh -c 'pip install -r docs/requirements.txt; mkdocs serve -a $$(ip route get 1 | awk '\''{print $$7}'\''):8000'
$(DOCKER) run ${MKDOCS_RUN_ARGS} --rm -it -p 8000:8000 -v ${CURRENT_DIR}:/docs -w /docs --entrypoint "" ${MKDOCS_DOCKER_IMAGE} sh -c 'pip install mkdocs; pip install $$(mkdocs get-deps); mkdocs serve -a $$(ip route get 1 | awk '\''{print $$7}'\''):8000'
# Verify that kubectl can connect to your K8s cluster from Docker
.PHONY: verify-kube-connect

View File

@@ -1,8 +1,8 @@
# Site
# Documentation Site
## Developing And Testing
The website is built using `mkdocs` and `mkdocs-material`.
The [documentation website](https://argo-cd.readthedocs.io/) is built using `mkdocs` and `mkdocs-material`.
To test:
@@ -10,7 +10,7 @@ To test:
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/).
Make a change to documentation and the website will rebuild and refresh the view.
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

View File

@@ -1,7 +1,7 @@
# Identity Center (AWS SSO)
!!! note "Are you using this? Please contribute!"
If you're using this IdP please consider [contributing](../../developer-guide/site.md) to this document.
If you're using this IdP please consider [contributing](../../developer-guide/docs-site.md) to this document.
A working Single Sign-On configuration using Identity Center (AWS SSO) has been achieved using the following method:

View File

@@ -1,7 +1,7 @@
# Okta
!!! note "Are you using this? Please contribute!"
If you're using this IdP please consider [contributing](../../developer-guide/site.md) to this document.
If you're using this IdP please consider [contributing](../../developer-guide/docs-site.md) to this document.
A working Single Sign-On configuration using Okta via at least two methods was achieved using:

View File

@@ -1,7 +1,7 @@
# OneLogin
!!! note "Are you using this? Please contribute!"
If you're using this IdP please consider [contributing](../../developer-guide/site.md) to this document.
If you're using this IdP please consider [contributing](../../developer-guide/docs-site.md) to this document.
<!-- markdownlint-disable MD033 -->
<div style="text-align:center"><img src="../../../assets/argo.png" /></div>

View File

@@ -210,7 +210,7 @@ nav:
- developer-guide/dependencies.md
- developer-guide/ci.md
- developer-guide/releasing.md
- developer-guide/site.md
- developer-guide/docs-site.md
- developer-guide/static-code-analysis.md
- Extensions:
- developer-guide/extensions/ui-extensions.md