OpenStack Documentation Contributor Guide¶
Abstract¶
This guide provides detailed instructions on the contribution workflow and conventions to be considered by all documentation contributors. Please follow these guidelines to keep the documentation structure, style, and syntax consistent.
Contents¶
- Quickstart
- Documentation team structure
- 2017/2018 documentation team vision
- Non-native English speakers
- Blueprints and specifications
- Project guide setup
- Landing pages on docs.openstack.org
- Governance tag documentation guidelines
- OpenStack API documentation
- Documentation bugs
- Writing documentation
- Writing style
- OpenStack user experience and user interface guidelines
- RST conventions
- JSON conventions
- Diagram guidelines
- Reviewing documentation
- Building documentation
- Redirecting documentation
- Using documentation tools
- Publishing a documentation release
