Self-hosted service
knative/docs avatar
knative/docs

knative/docs: The MkDocs Source Tree Behind knative.dev, Its uv Preview Script and Its Frozen Release Tags

User documentation for Knative components.

5,111 stars1,266 forksHTMLNOASSERTION

At a glance

What is it?
knative/docs holds the Markdown, templates and build tooling for the Knative documentation website. It is a contributor's repository, not Knative itself, and its release list stopped in 2021 while the branches keep moving.
Who is it for?
Open knative/docs if you want to fix a page, add a procedure or understand how the Knative website is built. Do not open it to install or run Knative, and do not read its GitHub releases as current.
Can I use it commercially?
Check first. The repository uses a licence we do not classify automatically, so read its LICENSE file before any commercial use.
Is it still maintained?
Yes. The repository received new commits within the last day.
What is it written in?
Mainly HTML, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • knative/docs5,111 ★ · +18
Star history
Repository2026-09-232026-11-15
knative/docs5.1k5.1k

18 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

This is the documentation's source tree, so nothing in it installs or runs Knative

The README opens by calling the repository the source file repository for the documentation on knative.dev. Its description is User documentation for Knative components, and the primary language GitHub reports is HTML. The documentation website is built with Material for MkDocs, and the content that appears there sits under the docs directory.

The consequence is a clear scope. If you arrived looking for the Knative controllers, the serving or eventing code, or a manifest to apply to a cluster, this is the wrong repository: it holds the pages that describe them. What it does hold is the docs directory, a code-samples directory, a contribute-to-docs guide with templates, an overrides directory for the site theme, and configuration for the build and for Netlify. Treat it as the place to improve text, not the place to obtain software.

The GitHub releases list ends at v0.21.x in 2021, while the work happens on main and in branches

The recent releases shown are v0.21.x from 2021-02-24, v0.20.x from 2021-01-13 and v0.19.x from 2020-11-18. They are titled Documentation releases, and they stopped years ago. Yet the last push to the repository was on 2026-11-01, so the repository is plainly in use.

The explanation is in how versions are kept. The README says each release of the docs is available on the website, starting with 0.3, and that their source files are all stored in branches of the repository, listed in doc-releases.md. So the releases page misleads anyone who reads it as a version history. To read what a specific Knative version's documentation said, switch to that version's branch or use the versioned docs on the website. The default branch is main, and it is what the live site tracks.

One script previews the site, and uv replaces manual Python setup

Local preview is a single command, run from the clone, with uv installed:

bash
./hack/mkdocs.sh

You then open http://127.0.0.1:8000/docs/, edit files under docs, and the page reloads when you save. The README states that uv manages Python and installs the locked dependencies into .venv, and that no manual Python setup, GitHub token, release branches or Docker are needed. The lock file uv.lock is what makes that repeatable.

Two limits matter. The command requires uv, so a machine without it has to install it first, and the same is true for a CI runner or a fresh container that you want to use for reviewing a docs change. And the README points to a separate local preview guide for Docker, other ports and build checks, which means that the simple path covers only the default port and the standard serve. If your port 8000 is busy, or you want to run the same checks CI runs, that guide is the next stop.

The Python pins hold the site on MkDocs 1.x and Material below 10

pyproject.toml describes the project as development tools for the documentation website, requires Python 3.11 or newer, and sets package to false because the repository is a website and not an installable Python package. The main dependencies are mkdocs at 1.6 or newer but below 2.0, mkdocs-material below 10.0, and plugins for excluding files, macros, awesome navigation, git revision dates, redirects and RSS. pygithub and semver 3.1.0 are also listed.

The file carries two comments worth understanding. One says local preview hooks use File.generated, introduced in MkDocs 1.6. The other says newer redirects releases pull in ProperDocs, which shares MkDocs' module and command line paths, so the existing MkDocs stack is kept until that migration is evaluated separately. That is why mkdocs-redirects is capped below 1.2.4. In practice, upgrading any one of these packages by hand can break the build, so use the lock file.

A Go module and a vendor directory sit next to a Python site, and their job is not spelled out

The top level also has go.mod, go.sum, a golang directory, a tools directory, a test directory and a vendor directory. The module is github.com/knative/docs on Go 1.25.0, and it requires go-github v32, yaml.v2 and knative.dev/hack. It also contains a replace directive that pins go.opencensus.io to v0.20.2.

The visible README never explains what the Go code does, so do not assume it is needed to preview or edit pages. The preview path described above uses uv and MkDocs alone. What the Go helpers do is a question for the golang and tools directories themselves. The practical risk is on the contributor side: a change that touches the vendored code or the module file belongs in a separate, deliberate pull request, since a docs fix does not call for it.

The README hides itself from the website with front matter that turns rendering off

The top of the README is YAML with a _build block that sets render and list to never. Directly under it, a note says the guide appears only on GitHub, not on the website, because it intentionally does not include front matter. The site generator treats files under docs as pages, so the README is kept out of the published site by design.

Contributors get two entry points: an Edit this page pencil icon on every published page, and the docs directory in the repository. New content starts from four templates in contribute-to-docs/templates for a concept, a procedure, troubleshooting and a blog entry. Before contributing you are asked to read the Knative contributor guidelines in the separate knative/community repository, which also holds code of conduct and governance. Questions go to the #knative-documentation channel on the CNCF Slack or to the documentation working group.

Two licence files and an undetected licence field leave the terms for you to read

GitHub reports the licence as NOASSERTION. The repository holds both LICENSE and LICENSE-docs at the top level, which fits a project that ships code and prose under possibly different terms. Because the detector did not name a licence, nothing on the repository page tells you under what terms you may reuse a paragraph or a build script.

If you plan to copy documentation text into your own material, or reuse the site configuration for another project, read both files and decide which applies to which part. The same caution applies to code-samples and third_party, which are separate directories with their own provenance. A practical habit is to record which file you relied on when you reuse something, so that a later change in the terms is easy to trace back to the source. Issues are welcome through the Create Issue link on any website page or directly on the repository, and the CODE-OF-CONDUCT.md, SECURITY.md and CONTRIBUTING.md files are in the root.

Editorial conclusion

Open knative/docs if you want to fix a page, add a procedure or understand how the Knative website is built. Do not open it to install or run Knative, and do not read its GitHub releases as current. Check the licence files and the branch for the Knative version you use before quoting anything from it.

Frequently asked questions

Is knative/docs the Knative software or its documentation?

It is the documentation only. The repository holds the source files for the Knative website at knative.dev, built with Material for MkDocs, and not the Knative components themselves.

How do I preview the Knative docs locally?

With uv installed, run ./hack/mkdocs.sh from your clone and open http://127.0.0.1:8000/docs/. The README says no manual Python setup, GitHub token, release branches or Docker are needed.

Where are the docs for older Knative versions?

Each docs release since 0.3 is on the website, and its source files are stored in branches of the repository, listed in doc-releases.md. The GitHub releases list stops at v0.21.x.

Official sources

  1. Issues
  2. knative/docs on GitHub
  3. Project website
  4. README
  5. Releases
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/knative-docs.svg)](https://hysenlabs.com/projects/knative-docs)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/knative-docs.svg)](https://hysenlabs.com/projects/knative-docs)

Was this useful?