this website is built using Hugo and uses the docsy theme
Run the website locally:
make serve
and access the website at http://localhost:1313/kfp-operator/
Build the website:
make
This will populate the /docs directory, which will be served on GitHub Pages.
To document different versions of the KFP Operator, we store a copy of the content/docs/
folder for each release version, under content/versions/<version>/
.
To create a new version:
- Run
make archive-version VERSION=<new_version>
wherenew_version
is the version, e.g.v0.6.0
- Ensure the new version is working correctly by validating via
make serve
- Generate the minified version of the website by running
make build
- Track the new files, commit the changes and push to the repository