Documentation
Likewise a changelog fragment should be added containing a summary of the change and optionally a migration guide.
This document discusses how to visually inspect documentation changes as they would be applied to the live website. All changes to documentation should be inspected locally before being pushed to a PR.
Note: Be sure to install hugo-extended.
We use to install the docsy theme. From the operator-sdk
directory, update the submodules to install the theme.
Any changes will be included in real time.
make test-docs
will validate changelog fragments, build doc HTML in a container, and check its links. Please consider running this locally before creating a PR to save CI resources.