mirror of
https://github.com/argoproj/argo-cd.git
synced 2026-02-20 01:28:45 +01:00
Fix local guide for building and testing docs (#19785)
Signed-off-by: todaywasawesome <dan@codefresh.io>
This commit is contained in:
4
Makefile
4
Makefile
@@ -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
|
||||
|
||||
@@ -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
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user