Source code for the cert-manager.io website, which includes documentation for each version of cert-manager as well as supported version information, installation instructions, tutorials, guides, FAQs and information for contributors.
The site uses next.js as a framework, and all documentation is written in MDX (Markdown).
At the very least, you'll need to install a couple of tools to be able to build and run the site locally and to test your changes.
The following tool(s) must be installed on your system prior to developing the website:
- cURL
- NodeJS, version 16+
- Golang, version 1.17+
We also assume you've got GNU coreutils installed, which is usually the case by default on Linux and should be installable via Homebrew on macOS.
There are two relevant branches used for website development: master and release-next.
Changes to master will be reflected on the live website shortly after they're merged. If your change is relevant
to any version of cert-manager which has already been released, your change likely needs to be made against master.
release-next is used for features which haven't been released in a stable version of cert-manager yet. Changes
will be reflected on a preview deployment for the release-next branch which is linked to from the main site.
First, docs go under content/; you shouldn't normally need to change files outside of content/ when
making any documentation change.
There are several folders in content/ and which one you need depends on what you're changing:
- Something which applies to the current version of cert-manager?
Add it todocs/and possibly to the specific version of cert-manager that's latest (e.g.v1.8-docs/) - Something which only applies to the next major version of cert-manager?
Add it todocs/but branch from therelease-nextbranch and merge the PR into that branch. See above. - Something which isn't "versioned", e.g. a page under "contributing", release notes or our supported-releases page?
Add it todocs/, which is the only place such pages should appear - Something which applies only to versions of cert-manager which have already been released?
Change specific version docs (e.g.v1.8-docs/)
If you're not sure, ask! Reach out to us on slack and we'll point you in the right direction!
When working on documentation, all links to other documentation pages should be relative to the document you're working on and should point at a named markdown file.
For example, take this snapshot of the "Certificate Concepts" page.
There's an external link to an RFC which is fully specified as expected:
see [RFC 5246 section 7.4.2](https://datatracker.ietf.org/doc/html/rfc5246#section-7.4.2)
But towards the end of the page we link to the "Certificate Usage" page:
[here](../usage/certificate.md).
If we're browsing the repository on the GitHub website (i.e. on this page), that relative link will work. In addition,
the next.js framework will ensure that the link is correct by stripping the .md, so the final rendered link
will be to https://cert-manager.io/docs/usage/certificate as we expect.
✨ When linking to an "Introduction" page, link to the README.md file directly. The framework will remove the whole
filename, so e.g. [example link](../usage/README.md) will link to https://cert-manager.io/docs/usage/.
Documentation files aren't automatically picked up or added to the navigation on the site when created.
If you want a file to appear, you need to add it to the manifest.json file for the given version of the
site you're working on.
For example, the manifest for the docs section contains the expected path for every file.
These tags are defined in Next.js code and config.
For docs pages, OpenGraph titles and descriptions are based on the titles and descriptions in the docs themselves, which
is configured in the frontmatter for each docs page. The magic happens in in pages/[...docs].jsx.
For pages except docs and for some other tags, look at changing next-seo.config.js.
Sometimes you'll want to add a comment which is only for documentation maintainers.
Use {/* my comment */} rather than the HTML-style comments you'd normally use for Markdown files. Other comment types will cause errors.
In rare occasions, when writing documentation for an unreleased feature, you may
notice that some recent changes in master aren't present in release-next. If
that is a problem, you will want to update release-next branch with the latest
changes from master. To update release-next with the changes made to
master, follow these steps:
-
Create a PR to merge
masterintorelease-nextusing this magic link. -
If you see the label
dco-signoff: no, add a comment on the PR with:/override dcoIt is necessary because some the merge commits have been written by the bot and do not have a DCO signoff.
First install nodejs (and package manager called npm).
Then install all the tools and packages required to build the website as follows:
npm ciThis command is similar to npm install but it ensures that you will have a clean install of all the dependencies.
The best development environment uses the Netlify CLI to serve the site locally. The Netlify CLI server closely matches the environment in which the website is deployed, and will enable local debugging of redirects and environment variables.
To run this server, install the Netlify CLI as follows:
npm install -g netlify-cliThen run the server:
./scripts/serverNote that the server will also be accessible locally at port 3000, but that on this port there'll be no support for debugging redirects or environment variables. Use port 8888.
Initial builds of a page on the development server can be quite slow - a few seconds - but after the initial build changes should be picked up quickly and the development server should be snappy to use.
After you have made changes to the website, you should run the verify script
to ensure things like spelling are valid.
To run all verification checks:
./scripts/verifyThis will automatically run a number of checks against your local environment, including:
- Lint checks on the nextjs code using next lint.
- Link checks on all pages using markdown-link-check.
- Spelling in all pages using mdspell.
- Formatting of the markdown in all pages using remark.
ℹ️ All these checks are also run automatically for pull requests. The results will be reported in the checks summary at the bottom of your GitHub PR. Read the cert-manager-website-presubmits.yaml prow configuration file and the check.yaml workflow file for more details.
On release, all output is placed into the out/ directory.
The full release process can be run through one script:
./scripts/build-releaseTo update the API documentation and CLI documentation, run:
./scripts/gendocs/generateThis should be done before every cert-manager release (if the API or CLI flags have changed) and any time the API or CLI of the satellite projects changes, and the changes should be committed.
Since there are many old versions of cert-manager, none of which change regularly (or at all), the website build process does not re-generate documentation for older versions, on the assumption that doing so would be a waste of effort.
The solution for achieving this is simple; the generation scripts for older cert-manager versions are commented out. To rebuild, uncomment them and then re-comment after.
For versions of cert-manager older than v1.8, API doc generation used the old cert-manager import
path and for this reason there's a different script - scripts/gendocs/generate-old-import-path-docs.
If you want to rebuild reference docs for versions older than 1.8, you'll also need to uncomment
generate-old-import-path-docs in scripts/gendocs/generate.
Public keys used for verifying signatures are served on the website statically, and are located
in public/public-keys directory.
See the docs on signing keys for more information about how and why these keys are generated and provided here.