openstack/openstack-manuals
Code Issues Proposed changes

[contributor] cleanup documentation bugs

Browse Source 
remove unimportant bugs category.

Change-Id: I4e5b1b19eaab3cf5da56939bcbc1bff5b80e3eab
Implements: blueprint contributor-guide-reorg
This commit is contained in:
KATO Tomoyuki 2016-07-25 11:28:45 +09:00
parent b106218692
commit 02a571d0c8
1 changed files with 19 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
doc/contributor-guide/source/doc-bugs.rst
View File

@ -1,9 +1,8 @@
.. _doc_bugs: .. _doc_bugs:
================== ============================
Documentation bugs Reporting documentation bugs
================== ============================
The Documentation team tracks all its work through bugs. This section includes The Documentation team tracks all its work through bugs. This section includes
the detailed overview of documentation bugs specifics. the detailed overview of documentation bugs specifics.
@ -33,15 +32,16 @@ changes are made in a patch, they are reviewed and approved, just like other
OpenStack code. OpenStack code.
To pick up a documentation bug or mark a bug as related to the documentation, To pick up a documentation bug or mark a bug as related to the documentation,
go to: `the aggregated list of documentation bugs from all OpenStack go to `the aggregated list of documentation bugs from all OpenStack projects
projects`_. <https://bugs.launchpad.net/openstack/+bugs?field.tag=documentation>`_.
**DocImpact** **DocImpact**
When adding code that affects documentation (for example, to add a new When adding code that affects documentation (for example, to add a new
parameter), the developer adds a DocImpact flag. This flag automatically parameter), the developer adds a DocImpact flag. This flag automatically
files a bug in the system explaining what needs to be done. For more files a bug in the system explaining what needs to be done. For more
information, see: `Documentation/DocImpact`_. information, see `Documentation/DocImpact
<https://wiki.openstack.org/wiki/Documentation/DocImpact>`_.
Launchpad projects and repositories Launchpad projects and repositories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -49,17 +49,18 @@ Launchpad projects and repositories
The Documentation team uses two projects for tracking documentation bugs The Documentation team uses two projects for tracking documentation bugs
across OpenStack: across OpenStack:
* Launchpad bug area `openstack-manuals`_ is the default one for doc bugs and * Launchpad bug area `openstack-manuals
should be used for docs sourced from these repositories: <https://bugs.launchpad.net/openstack-manuals>`_ is the default one for
doc bugs and should be used for docs sourced from these repositories:
* clouddocs-maven-plugin
* openstackdocstheme * openstackdocstheme
* openstack-doc-tools * openstack-doc-tools
* openstack-manuals * openstack-manuals
* security-doc * security-doc
* Launchpad bug area `openstack-api-site`_ is used for the api-site API * Launchpad bug area `openstack-api-site
repository. <https://bugs.launchpad.net/openstack-api-site>`_ is used for
the api-site API repository.
.. _doc_bugs_triaging: .. _doc_bugs_triaging:
@ -142,42 +143,15 @@ committer of the change that triggered the bug report, mark it as
specification and handle it since the documentation team will not specification and handle it since the documentation team will not
document third-party drivers. document third-party drivers.
Doc bug categories Doc bug categories
------------------ ------------------
To help with bug fixing, use these quick links to pick a certain subset of To help with bug fixing, use these quick links to pick a certain subset of
bugs: bugs:
* `list of all documentation bugs`_ * `list of all documentation bugs
* `list of all API site bugs`_ <https://bugs.launchpad.net/openstack-manuals>`_
* `low hanging fruit documentation bugs`_ * `list of all API site bugs
* `nova-related documentation bugs`_ <https://bugs.launchpad.net/openstack-api-site>`_
* `keystone-related documentation bugs`_ * `low hanging fruit documentation bugs
* `neutron-related documentation bugs`_ <https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=low-hanging-fruit>`_
* `swift-related documentation bugs`_
* `glance-related documentation bugs`_
* `cinder-related documentation bugs`_
* `xen-related documentation bugs`_
.. Links
.. _`the aggregated list of documentation bugs from all OpenStack projects`: https://bugs.launchpad.net/openstack/+bugs?field.tag=documentation
.. _`Documentation/DocImpact`: https://wiki.openstack.org/wiki/Documentation/DocImpact
.. _`list of all documentation bugs`: https://bugs.launchpad.net/openstack-manuals
.. _`list of all API site bugs`: https://bugs.launchpad.net/openstack-api-site
.. _`openstack-manuals`: https://bugs.launchpad.net/openstack-manuals
.. _`openstack-api-site`: https://bugs.launchpad.net/openstack-api-site
.. _`low hanging fruit documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=low-hanging-fruit
.. _`nova-related documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=nova
.. _`keystone-related documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=keystone
.. _`neutron-related documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=neutron
.. _`swift-related documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=swift
.. _`glance-related documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=glance
.. _`cinder-related documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=cinder
.. _`xen-related documentation bugs`: https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=xen