mirror of
https://github.com/kata-containers/kata-containers.git
synced 2026-04-30 21:03:49 +00:00
56cdfa831f
Adding the pod annotation config to the doc site. A symlink is created at docs/pod-annotations.md that points to how-to/how-to-set-sandbox-config-kata.md so that the URL for this file will be created at `/pod-annotations`. Also adding brief contrbuting guidelines and how-to's for running the documentation site locally for local previews. Signed-off-by: LandonTClipp <11232769+LandonTClipp@users.noreply.github.com>
22 lines
1.0 KiB
Markdown
22 lines
1.0 KiB
Markdown
# Documentation Contributions
|
|
|
|
The documentation system is built using a static site generator called [mkdocs-materialx](https://jaywhj.github.io/mkdocs-materialx/), a fork of [mkdocs-material](https://squidfunk.github.io/mkdocs-material/).
|
|
|
|
## Local Serving
|
|
|
|
All documentation files are in the `docs/` subfolder. When modifying docs, you can run `make docs-serve` at the top-level of the project to build and serve them locally:
|
|
|
|
```
|
|
$ make docs-serve
|
|
INFO - [17:37:42] Serving on http://0.0.0.0:8000/kata-containers/
|
|
```
|
|
|
|
## Adding New Files
|
|
|
|
Markdown files should be organized in a flat topology as much as possible. The location of the markdown files will map directly its URL, so they should not be moved once they are created. The navigation structure of the static site is controlled via the `docs/.nav.yml` file.
|
|
|
|
## Configuration
|
|
|
|
The configuration of the build system is controlled through the `mkdocs.yaml` file. The reference for various parameters can be found at the [mkdocs-materialx](https://jaywhj.github.io/mkdocs-materialx/setup/index.html) website.
|
|
|