mirror of https://github.com/knative/docs.git
a3e16fd7c6
* Add docker instructions to preview website locally Signed-off-by: Carlos Santana <csantana23@gmail.com> * minor updates Signed-off-by: Carlos Santana <csantana23@gmail.com> |
||
|---|---|---|
| .. | ||
| getting-started | ||
| images | ||
| style-guide | ||
| templates | ||
| what-to-contribute | ||
| README.md | ||
| docs-release-process.md | ||
README.md
Knative docs contributor guide
Getting started
- Code of Conduct
- Becoming a contributor
- GitHub workflow for Knative documentation
- Previewing the website locally
- Formatting content
- Navigation and redirects
- Branches and cherrypicking
What to contribute
Templates
Style
You don't need to read the whole style guide before contributing to Knative documentation. Unpolished contributions delivered early are better than perfect contributions delivered late.
If you notice gaps in the style guide or have queries, please post in the Docs Slack channel.
- Documenting code
- Formatting standard and conventions
- Voice and language
- Word and phrase list
- Content re-use
- Using shortcodes (TBD)
Maintainer guides
How-to guides for maintainers of the Knative docs repo and website: