- Notifications
You must be signed in to change notification settings - Fork1.2k
User documentation for Knative components.
License
Unknown, CC-BY-4.0 licenses found
Licenses found
knative/docs
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
_build | ||||
---|---|---|---|---|
|
(This guide only appears on GitHub, not the website, because itintentionally does not include YAML front-matter.)
Welcome to the source file repository for our documentation onhttps://knative.dev.
The Knative documentation website is built usingMaterial for MkDocs.
View all Knative documentation and walk through our code samples on thewebsite.
The Knative website includes versioned docs for recent releases, the Knativeblog, links to all community resources, as well as Knative governance andcontributor guidelines.
For instructions, refer to Knative'sdocs contributor guide.
Source files for the documentation on the website are located within the/docs
directory of this repo.
Each release of the Knative docs is available on the website (starting with0.3) and their source files are all stored inbranches of this repo.
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 outCLOTRIBUTORfor a list of all the help wanted issues in Knative.
If you want to contribute a fix or add new content to the documentation, you cannavigate through the/docs
repo or use theEdit this page
pencil icon on each of the pages ofthe website.
Before you can contribute, first start by reading the Knative contributorguidelines and learning about our community and requirements. In addition toreading about how to contribute to the docs, you should take a moment to learnabout the Knative code of conduct, governance, values, and the various workinggroups and committees.
Knative community and contributor guidelines
Source files for all Knative community and governance topics are locatedseparately in theknative/communityrepo.
To help you get started, see the following resources:
Knative docs contributor's guide -- Contains information about howto contribute.
New content templates:
#knative-documentation on the CNCF Slack -- The #knative-documentation channelis the best place to go if you have questions about making changes to thedocumentation. We're happy to help!
Documentation working group -- Come joinus in the working group to meet other docs contributors and ask any questionsyou might have.
Your help and feedback is always welcome!
If you find an issue please let us know, either by clicking theCreate Issue
on anyof the website pages, or by directly opening anissue here in the repo.
If you have a question that you can't find an answer to, we would also like tohear about that. In addition to our docs, you can also reach out to thecommunity for assistance. For example, ask a documentation-specific question onthe#knative-documentation
channel inSlack.
Also see theKnative community resource pagesfor a list of all the available community resources, including links to thevarious community discussion groups for both development as well astroubleshooting.
About
User documentation for Knative components.