mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-14 20:56:42 +00:00
docs: add instructions for working on documentation
(cherry picked from commit 0c276b6298
)
This commit is contained in:
parent
1f492784c0
commit
6874ea3b71
1 changed files with 25 additions and 1 deletions
|
@ -239,4 +239,28 @@ for up-to-date information about the required volume mounts.
|
|||
|
||||
## Documentation
|
||||
|
||||
*WORK IN PROGRESS...*
|
||||
All documentation resides under the [docs](/docs) directory in the source tree.
|
||||
It is designed to be served as a html site by [GitHub
|
||||
Pages](https://pages.github.com/).
|
||||
|
||||
Building the documentation is containerized in order to fix the build
|
||||
environment. The recommended way for developing documentation is to run:
|
||||
|
||||
```bash
|
||||
make site-serve
|
||||
```
|
||||
|
||||
This will build the documentation in a container and serve it under
|
||||
[localhost:4000/](http://localhost:4000/) making it easy to verify the results.
|
||||
Any changes made to the `docs/` will automatically re-trigger a rebuild and are
|
||||
reflected in the served content and can be inspected with a simple browser
|
||||
refresh.
|
||||
|
||||
In order to just build the html documentation run:
|
||||
|
||||
```bash
|
||||
make site-build
|
||||
```
|
||||
|
||||
This will generate html documentation under `docs/_site/`.
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue