Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/knative/docs

User documentation for Knative components.
https://github.com/knative/docs

documentation faas hacktoberfest istio knative kubernetes paas serverless

Last synced: 5 days ago
JSON representation

User documentation for Knative components.

Awesome Lists containing this project

README 

        
---

_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



For instructions, refer to Knative's [docs contributor 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:

  - [Concept](contribute-to-docs/templates/template-concept.md)

  - [Procedure](contribute-to-docs/templates/template-procedure.md)

  - [Troubleshooting](contribute-to-docs/templates/template-troubleshooting.md)

  - [Blog](contribute-to-docs/templates/template-blog-entry.md)



### Getting help



- [#knative-documentation on the CNCF Slack](https://cloud-native.slack.com/archives/C04LY5G9ED7) -- The #knative-documentation 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](https://github.com/knative/community/blob/main/working-groups/WORKING-GROUPS.md#documentation) -- 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 please let us know, either by clicking the `Create Issue` on any

of the website pages, or by directly opening an

[issue](https://github.com/knative/docs/issues/new/choose) 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. In addition to our docs, you can also reach out to the

community for assistance. For example, ask a documentation-specific question on

the `#knative-documentation` channel in [Slack](https://cloud-native.slack.com/archives/C04LY5G9ED7).



Also see the [Knative community resource pages](https://knative.dev/docs/community/)

for a list of all the available community resources, including links to the

various community discussion groups for both development as well as

troubleshooting.