From ac1700914c14971838ae29e3c3378444b45664c2 Mon Sep 17 00:00:00 2001 From: "Ian Y. Choi" Date: Tue, 2 May 2017 23:35:23 +0200 Subject: [PATCH] [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 --- doc/upstream-training/source/slides/docs.rst | 53 ++++++++++++-------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/doc/upstream-training/source/slides/docs.rst b/doc/upstream-training/source/slides/docs.rst index 57a77a9c..deb89280 100644 --- a/doc/upstream-training/source/slides/docs.rst +++ b/doc/upstream-training/source/slides/docs.rst @@ -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 `_ + and separate core teams for `docs-specs `_ + , `security-doc `_ + , `training-guides `_ + , and `training-labs `_ + +- `Documentation cross-project liaisons `_ + 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 `_ +- Project repos can have installation tutorial and developer documentation + + - Example: `Heat repository `_ + + - `Installation Tutorial (Ocata) `_ + is published from install-guide directory in stable/ocata branch + - `Developer documentation `_ + 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