User documentation for Knative components.
Go to file
Tomas Isdal 7dd9f03762
Update 2020-05-toc_election_results.md
2020-05-15 11:37:09 -07:00
.github Update template to avoid branch confusion (#2217) 2020-02-14 11:46:41 -08:00
blog Update 2020-05-toc_election_results.md 2020-05-15 11:37:09 -07:00
community Add a test for "index.md" frontmatter and fix the repo to match (#2377) 2020-05-15 08:41:02 -07:00
docs Add a test for "index.md" frontmatter and fix the repo to match (#2377) 2020-05-15 08:41:02 -07:00
hack Add `--upgrade` to `./hack/update-deps.sh` (#2263) 2020-03-02 18:25:52 -08:00
test Add a test for "index.md" frontmatter and fix the repo to match (#2377) 2020-05-15 08:41:02 -07:00
vendor [master] Auto-update dependencies (#2460) 2020-05-14 14:23:00 -07:00
.gitignore Rename Choice to Parallel and cases to branches (#1786) 2019-09-16 12:37:42 -07:00
Gopkg.lock [master] Auto-update dependencies (#2460) 2020-05-14 14:23:00 -07:00
Gopkg.toml updating to the latest cloudevents sdk - v2.0.0-RC1 (#2386) 2020-04-13 09:31:11 -07:00
LICENSE Add license footer and text (#204) 2018-07-19 12:05:32 -07:00
OWNERS Clarifying Docs contributor roles (#958) 2019-03-13 19:12:45 -07:00
OWNERS_ALIASES Add jonatasbaldin in docs-reviewers (#2424) 2020-04-30 13:23:42 -07:00
README.md Link instructions to run website locally (#2465) 2020-05-14 14:04:00 -07:00
_index.html Add a test for "index.md" frontmatter and fix the repo to match (#2377) 2020-05-15 08:41:02 -07:00
background.png Merge website files into Master (#1025) 2019-03-20 13:48:47 -07:00
doc-releases.md change list to releases landing page (#1540) 2019-06-26 16:51:05 -07:00
search.md Format markdown (#1070) 2019-03-24 21:12:49 -07:00
smoketest.md Add tabs to smoketest page (#2151) 2020-02-10 13:56:07 -08:00

README.md

Knative documentation

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

Website

The Knative documentation website is built with hugo templates in Knative Website Repo.

View published documentation

View all Knative documentation and walk-through our code samples on the website.

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 website locally

Refer to this doc in the website repo.

Website source files

Source files for the documentation on the website are located within the /docs directory of this repo.

If you want to contribute a fix or add new content to the documentation, you can navigate through this repo or use the Edit this page 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

Source files for all Knative community and governance topics are located separately in the knative/community repo.

Documentation versions for Knative releases

Each release of the Knative docs are available in the website (starting with 0.3) and their source files are all stored in branches of this repo.

Help and support

Your help and feedback is always welcome!

If you find an issue let us know, either by clicking the Create Issue on any of the website pages, or by directly opening an issue here in the repo.

If you have a question that you can't find an answer to, we would also like to hear about that too. In addition to our docs, you can also reach out to the community for assistance. For example, ask a documentation specific question on the #docs channel in Slack.

Also see the Knative community resource page for a list of all the available community resources, including links to the various community discussion groups for both development as well as troubleshooting.