The documentation site is built and published automatically to https://hypershift-docs.netlify.app.
All documentation lives in the
docs directory of the Git repository.
All content should be Markdown files placed in the
The MkDocs configuration file
contains all the MkDocs and Material theme configuration, including the navigation
structure for the site.
quay.io/hypershift/mkdocs-material:latest image (Dockerfile)
is published to provide an easy and portable way to run
mkdocs fully configured
to preview the site equivalent to the published site.
file in the repository root is a minimal overview which quickly links users to
the latest published documentation. Most content should go in the docs.
Preview the site locally
To start a live preview of the site which automatically rebuilds and refreshes in
response to local content and configuration changes, run the following from the
Visit the site at http://0.0.0.0:8000.
serve-containerized Make target runs the
image with the local container runtime. Running
mkdocs natively is possible
but not supported.
If you need more control over the local preview server, consult the Makefile as a guide to constructing your own local server command.
Generate the API reference
gen-crd-api-reference-docs tool processes the HyperShift API Go type
definitions and reads the
Kubernetes Custom Resource Definition
metadata associated with the API types. Then
a Go template
which is provided with context about the processed Go packages. The output of
template execution is the
docs/content/reference/api.md file, which contains the
API reference documentation content.
- To change documentation of specific API types, edit the API Go type definitions.
- To change the structure of the API reference page itself, edit the
To run the API reference docs generator, run the following from the HyperShift Git repository root: