Question 1

How do I preview Knative documentation changes locally?

Accepted Answer

Follow the instructions in the docs contributor guide to set up Material for MkDocs and run the site locally. This lets you see how edits will look on knative.dev before submitting them, ensuring accuracy and formatting.

Question 2

What templates are available for contributing to Knative docs?

Accepted Answer

Knative/docs provides structured templates for concepts, procedures, troubleshooting guides, and blog entries. These templates help maintain consistency and are accessible in the 'New content templates' section of the repository.

Question 3

How does Knative handle older versions of documentation?

Accepted Answer

Each Knative release has its documentation source stored in separate branches of this repo, with all versions published on knative.dev. This ensures users can access docs for specific releases, starting from version 0.3.

Question 4

Knative docs vs Kubernetes docs: which is easier to contribute to?

Accepted Answer

Knative/docs uses Material for MkDocs with specific templates, making it streamlined for its ecosystem, while Kubernetes docs have a different setup. Knative's approach might be simpler if you're familiar with MkDocs, but Kubernetes has broader community resources.

Question 5

How can I get help with Knative documentation issues?

Accepted Answer

Ask questions on the #knative-documentation channel in CNCF Slack or join the documentation working group. You can also open issues directly in the GitHub repository for specific problems or feedback.

Question 6

What tools are used to build the Knative documentation website?

Accepted Answer

The website is built using Material for MkDocs, a static site generator for technical documentation. Source files are in Markdown and managed in this GitHub repository, with versioning handled through branches.

Knative

What is Knative?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions