b7f1817902
training-labs repo is retired now[1], this commit removes the reference of it. Depends-On: https://review.opendev.org/c/openstack/training-labs/+/817505 [1] http://lists.openstack.org/pipermail/openstack-discuss/2021-October/025586.html Change-Id: I21ec3dde83a1c11b9611b3cc1df6c3f0d14d5cae
2.7 KiB
2.7 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 , and training-guides
- 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