mirrors/external-secrets
1
0
Fork 0
mirror of https://github.com/external-secrets/external-secrets.git synced 2024-12-14 11:57:59 +00:00
Code Activity

Adding cleanup instructions

Browse source 
Signed-off-by: Gustavo Fernandes de Carvalho <gustavo.carvalho@container-solutions.com>
This commit is contained in:
Gustavo Fernandes de Carvalho 2022-02-01 16:02:13 -03:00
parent b7ecdf6f58
commit 00b7ff25f5
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/contributing-devguide.md
View file

@ -104,7 +104,7 @@ helm upgrade --install external-secrets ./deploy/charts/external-secrets/ --set
## Documentation
We use [mkdocs material](https://squidfunk.github.io/mkdocs-material/) to generate this
We use [mkdocs material](https://squidfunk.github.io/mkdocs-material/) and [mike](https://github.com/jimporter/mike) to generate this
documentation. See `/docs` for the source code and `/hack/api-docs` for the build process.
When writing documentation it is advised to run the mkdocs server with livereload:
@ -121,3 +121,7 @@ make serve-docs
```
Open `http://localhost:8000` in your browser.
Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local `gh-pages` branch.
When finished writing/reviewing the docs, clean up your local docs branch changes with `git branch -D gh-pages`