docs

---
_build:
  render: never
  list: never
---
(This guide only appears on GitHub, not the website, because it
**intentionally** does not include YAML front-matter.)

# Knative documentation

Welcome to the source file repository for our documentation on
https://knative.dev.

## Website

The Knative documentation website is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

### View published documentation

View all Knative documentation and walk through our code samples on the
[website](https://knative.dev).

The Knative website includes versioned docs for recent releases, the Knative
blog, links to all community resources, as well as Knative governance and
contributor guidelines.

### Run the website locally

With [uv](https://docs.astral.sh/uv/getting-started/installation/) installed, run
this from your clone:

```bash
./hack/mkdocs.sh
```

Open <http://127.0.0.1:8000/docs/>, edit files under `docs/`, and save to see
changes reload automatically. uv manages Python and installs the locked
dependencies into `.venv/`; no manual Python setup, GitHub token, release
branches, or Docker are needed.

For Docker, other ports, and build checks, see the
[local preview guide](contribute-to-docs/getting-started/previewing-docs-locally.md).

### Website source files

Source files for the documentation on the website are located within the
[`/docs`](docs) directory of this repo.

### Documentation versions for Knative releases

Each release of the Knative docs is available on the website (starting with
0.3) and their source files are all stored in
[branches of this repo](doc-releases.md).

## Contributing to docs

We're excited that you're interested in contributing to the Knative documentation! Check out the resources below to get started.

If you are interested in contributing to Knative more broadly, please check out [CLOTRIBUTOR](https://clotributor.dev/search?project=knative&page=1)
for a list of all the help wanted issues in Knative.

### Getting started

If you want to contribute a fix or add new content to the documentation, you can
navigate through the [`/docs`](docs) repo or use the `Edit this page` pencil icon on each of the pages of
the website.

Before you can contribute, first start by reading the Knative contributor
guidelines and learning about our community and requirements. In addition to
reading about how to contribute to the docs, you should take a moment to learn
about the Knative code of conduct, governance, values, and the various working
groups and committees.

[Knative community and contributor guidelines](https://github.com/knative/community/)

Source files for all Knative community and governance topics are located
separately in the [knative/community](https://github.com/knative/community/)
repo.

To help you get started, see the following resources:

- [Knative docs contributor's guide](contribute-to-docs/README.md) -- Contains information about how
  to contribute.

- New content templates:
  - [Conc