Andreas Jaeger ee4df7f88a Update for OpenDev changes

Update URLs for the OpenDev changes, we now use opendev.org as git
server and review.opendev.org.

Change-Id: I2946d2134d6e840fbd32356398e424270793d2cc

2019-04-22 17:50:05 +02:00

2.8 KiB

Raw Blame History

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

Bug reports

Contributor guide

https://docs.openstack.org/doc-contrib-guide/index.html

This guide provides detailed instructions on the contribution workflow and conventions to be considered by all documentation contributors.

Building documentation

https://docs.openstack.org/doc-contrib-guide/docs-builds.html

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

2.8 KiB Raw Blame History