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
- Non-native English speakers
- Content specification
- Project guide setup
- 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
- Using documentation tools
- Publishing a documentation release
Search¶
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.