165d34e38b
Since Queens update the link URL of 'Documentation Contributor Guide' to distinguish this document from the new document aimed at all new OpenStack contributors. So this patch correct the wrong url. Refer to 'https://docs.openstack.org/releasenotes/openstack-manuals/queens' Change-Id: I4d30d25db5f0b602dbad87f9ab714dd2ff8d8958
2.8 KiB
2.8 KiB
OpenStack Documentation
Note
Tags: [operator] [user] [new_dev] [dev]
Mission
- Provide documentation for core OpenStack projects to promote OpenStack.
- Develop and maintain tools and processes to ensure quality, accurate documentation.
- Treat documentation like OpenStack code.
Sites
Documentation team structure
- Specialty teams
- API, Contributor Guide, Security Guide, Training Guides, Training Labs
- Docs cores and separate core teams for docs-specs , contributor-guide , security-doc , training-guides , and training-labs
- Documentation cross-project liaisons for questions, reviews, doc bug triaging, and patching docs
Repositories
- Official deliverables with repositories
- Project repos have installation tutorials and developer
documentation
- Example: Heat
repository
- Developer documentation is published from doc directory in master branch
- Installation Tutorial (Ocata) is published from install-guide directory in stable/ocata branch
- Example: Heat
repository
Bug reports
- https://bugs.launchpad.net/openstack-manuals
- https://bugs.launchpad.net/openstack-api-site
- https://bugs.launchpad.net/openstack-training-guides
- https://storyboard.openstack.org/#!/project/913
Contributor guide
This guide provides detailed instructions on the contribution workflow and conventions to be considered by all documentation contributors.
Building documentation
EOL documents
- EOL documents are not maintained in the documentation repositories,
the content is frozen, but published documents are accessible by retention
policy
- See EOL status at: https://releases.openstack.org