Documentation Updates
Information helpful for contributing simple documentation updates.
- Documentation for https://karpenter.sh/docs/ is built under website/content/en/preview/.
- Documentation updates should be made to the “preview” directory. Your changes will be promoted to website/content/en/docs/ by an automated process after the change has been merged.
- Your site is built automatically when you push a change under
website/, but the preview is only deployed on request: a maintainer leaves a/karpenter previewreview comment on your PR and the preview URL is posted as a comment a few minutes later. Pushing a new commit does not refresh the preview, so ask for another/karpenter previewonce you have made changes. The preview is built from the exact commit the maintainer reviewed, so if your most recent commit changes nothing underwebsite/there is no build to publish — push awebsite/change and ask against that commit. Builds are kept for 14 days. - If your update applies to more than just the current version of Karpenter, please backport your changes into all of the versions under website/content/en/ besides the /docs/ folder
- Document behavior that users can rely on, not implementation details. Details such as tie-breaking or iteration order, or which internal code path handles a case, can change between releases without notice, and documenting them invites users to depend on them. Describe the supported way to get an outcome instead — for example, “give the preferred NodePool a higher weight” rather than describing how Karpenter orders NodePools with the same weight.
Last modified October 28, 2026: docs: add reboot startup taints warning (#9820) (f5c7935)