[upstream] Refines Documentation section

- Expands from specialty team to documentation team structure
- Explains project installation tutorials and developer documentation
  which are also related with documentation activities
- Includes training-guides in bug reports
- Explains draft documentation, documentation testing activities,
  and EOL-ed documents

Change-Id: I26561626a7c2c4c2c8ab7233615dd75acc467bf1
This commit is contained in:
Ian Y. Choi 2017-05-02 23:35:23 +02:00
parent e7678af6ed
commit ac1700914c

View File

@ -20,37 +20,41 @@ Sites
- http://docs.openstack.org
- http://developer.openstack.org
Specialty teams
===============
Documentation team structure
============================
- API
- Configuration Reference and CLI Reference
- High Availability Guide
- Hypervisor Tuning Guide
- Installation guides
- Networking Guide
- Operations and Architecture Design guides
- Security Guide
- Training guides
- Training labs
- User guides
- Specialty teams
- API, Security Guide, Training Guides, Training Labs
- `Docs cores <https://review.openstack.org/#/admin/groups/30,members>`_
and separate core teams for `docs-specs <https://review.openstack.org/#/admin/groups/384,members>`_
, `security-doc <https://review.openstack.org/#/admin/groups/347,members>`_
, `training-guides <https://review.openstack.org/#/admin/groups/360,members>`_
, and `training-labs <https://review.openstack.org/#/admin/groups/1118,members>`_
- `Documentation cross-project liaisons <https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation>`_
for questions, reviews, doc bug triaging, and patching docs
Repositories
============
- ``docs-specs``
- ``openstack-doc-tools``
- ``openstack-manuals``
- ``openstackdocstheme``
- ``security-doc``
- ``training-guides``
- ``training-labs``
- `Official deliverables with repositories <https://governance.openstack.org/tc/reference/projects/documentation.html#deliverables>`_
- Project repos can have installation tutorial and developer documentation
- Example: `Heat repository <https://git.openstack.org/cgit/openstack/heat/tree/>`_
- `Installation Tutorial (Ocata) <https://docs.openstack.org/project-install-guide/orchestration/ocata/>`_
is published from install-guide directory in stable/ocata branch
- `Developer documentation <https://docs.openstack.org/developer/heat/>`_
is published from doc directory in master branch
Bug reports
===========
- https://bugs.launchpad.net/openstack-manuals
- https://bugs.launchpad.net/openstack-api-site
- https://bugs.launchpad.net/openstack-training-guides
Contributor guide
=================
@ -64,3 +68,12 @@ Building documentation
======================
- http://docs.openstack.org/contributor-guide/docs-builds.html
Draft documentation, testing, and EOL
=====================================
- https://docs.openstack.org/draft/draft-index.html
- Some documents (e.g., install-guides) require testing with releases
- EOL documents are not maintained in documentation repositories
- See EOL status at: https://releases.openstack.org