mirror of https://github.com/knative/docs.git
* Reorganise contributing docs * Fix whitespace * Fix typo * Tweak wording * Fix formatting * Update CONTRIBUTING.md * Update DEVELOPMENT.md * lint * lint * Fix broken link * Fix link * Update README.md * Update README.md * fix link * Tweaks * Update formatting.md * Update github-workflow.md * Remove info about Website repo * Remove link to community website * Update previewing-docs-locally.md * Fix formatting * Fix links * Remove preview for blog * Fix formatting |
||
---|---|---|
.. | ||
getting-started | ||
images | ||
style-guide | ||
templates | ||
what-to-contribute | ||
README.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)