User documentation for Knative components.
Go to file
Carlos Santana 6f7060b74f
add v0.25 mkdocs, remove v0.21 hugo (#4151)
* add v0.25 mkdocs, remove v0.21 hugo

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* remove v0.21 hugo archived

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* add -L for curl to catch errors when missing variabled in url path

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* fix release branch for old mkdocs version 0.24

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* fix message for serve

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* adding back archive v0.21 to make PR clear

Signed-off-by: Carlos Santana <csantana23@gmail.com>
2021-08-24 01:16:23 -07:00
.github Add references to upating nav menu (#4107) 2021-08-12 09:51:35 -07:00
archived bug fix according to https://github.com/open-telemetry/opentelemetry-collector/issues/3845. (#4120) 2021-08-17 20:28:08 -07:00
blog fixing broken links (#4014) 2021-07-26 06:59:16 -07:00
community Removed errant ./ instances (#4044) 2021-07-22 07:54:03 -07:00
config add docs for byo certificate via domainmapping (#4104) 2021-08-18 05:20:09 -07:00
docs Added definition list formatting rule (#4144) 2021-08-20 06:30:06 -07:00
golang Generate redirects for new repos (#4015) 2021-07-15 00:41:32 -07:00
hack add v0.25 mkdocs, remove v0.21 hugo (#4151) 2021-08-24 01:16:23 -07:00
help/maintainer Salvage old contributor docs (#4020) 2021-07-16 05:32:09 -07:00
overrides Normalize vendor logos (#3974) 2021-07-08 08:38:23 -07:00
test Issue 3642 finishing up eventing sanity check (#3743) 2021-06-08 05:53:41 -07:00
third_party/VENDOR-LICENSE upgrade to latest dependencies (#3839) 2021-06-24 04:40:45 -07:00
tools/redir-gen Generate Golang vanity URL redirects (#3806) 2021-06-15 13:39:21 -07:00
tutorials/katacoda Removed errant ./ instances (#4044) 2021-07-22 07:54:03 -07:00
vendor upgrade to latest dependencies (#4127) 2021-08-19 03:22:04 -07:00
.gitattributes Incorporate static version of old docs in to site (#3888) 2021-06-30 11:31:10 -07:00
.gitignore Build blog and community with hugo (#3558) 2021-05-12 14:05:48 -07:00
.wokeignore Ignore false-positive divisive language flagging (#3033) 2020-11-12 08:45:00 -08:00
CONTRIBUTING.md Removed errant ./ instances (#4044) 2021-07-22 07:54:03 -07:00
DEVELOPMENT.md fixing broken links (#4014) 2021-07-26 06:59:16 -07:00
LICENSE Add license footer and text (#204) 2018-07-19 12:05:32 -07:00
OWNERS Merging main into mkdocs, add Beta contributor's guide (hidden) to the website, create `/snippets` directory (#3610) 2021-05-19 09:18:16 -07:00
OWNERS_ALIASES Update community files (#4142) 2021-08-19 22:51:05 -07:00
README.md Update docs repo README for MkDocs (#4049) 2021-07-29 09:07:57 -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 Drop unnecessary occurrences of master (#3333) 2021-03-11 05:08:26 -08:00
go.mod upgrade to latest dependencies (#4127) 2021-08-19 03:22:04 -07:00
go.sum upgrade to latest dependencies (#4127) 2021-08-19 03:22:04 -07:00
katacoda.yaml adding katacoda tutorials (#3142) 2021-03-30 10:30:21 -07:00
mkdocs.yml Fix redirects (#3933) 2021-07-05 09:04:47 -07:00
netlify.toml Adding redirect guidance, redirect for community (#4001) 2021-07-14 14:16:32 -07:00
package-lock.json Bump node dependencies (#3695) 2021-06-02 16:17:44 -07:00
package.json add docker development workflow (#3738) 2021-06-08 05:43:41 -07:00
requirements.txt Updates for admin guide, misc (#3601) 2021-05-19 15:18:16 -07:00
search.md Format markdown (#1070) 2019-03-24 21:12:49 -07:00
smoketest.md Consolidate all "docs" help info into single location (#3437) 2021-04-26 10:57:40 -07:00

README.md

_build
render list
never 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.

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

For instructions, see Knative's MkDocs contributor guide.

Website source files

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

Documentation versions for Knative releases

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

Contributing to docs

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

Getting started

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

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

To help you get started, see the following resources:

Getting help

  • #docs on the Knative Slack -- The #docs channel is the best place to go if you have questions about making changes to the documentation. We're happy to help!

  • Documentation working group -- Come join us in the working group to meet other docs contributors and ask any questions you might have.

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.