<commit_before>.. _doc_bugs:

============================
Reporting documentation bugs
============================

The Documentation team tracks all its work through bugs. This section includes
the detailed overview of documentation bugs specifics.

Bugs differ depending on:

* The way they are filed:

  * Manually
  * Automatically (through the DocImpact flag)

* The required changes:

  * Fix spelling errors or formatting
  * Update existing content
  * Add new content

.. note::

   To work on documentation bugs, join the openstack-doc-bugs team on
   Launchpad. For more information, see :ref:`first_timers`.

Go through the triaging process and look for possible duplicate bugs
before working on a bug. Do not work on a documentation bug until it is set to
`Confirmed`. Ideally, another person has to confirm the bug for you. Once the
changes are made in a patch, they are reviewed and approved, just like other
OpenStack code.

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 projects
<https://bugs.launchpad.net/openstack/+bugs?field.tag=documentation>`_.

**DocImpact**

When adding code that affects documentation (for example, to add a new
parameter), the developer adds a DocImpact flag. This flag automatically
files a bug in the system explaining what needs to be done. For more
information, see `Documentation/DocImpact
<https://wiki.openstack.org/wiki/Documentation/DocImpact>`_.

Launchpad projects and repositories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Documentation team uses two projects for tracking documentation bugs
across OpenStack:

* Launchpad bug area `openstack-manuals
  <https://bugs.launchpad.net/openstack-manuals>`_ is the default one for
  doc bugs and should be used for docs sourced from these repositories:

  * openstackdocstheme
  * openstack-doc-tools
  * openstack-manuals
  * security-doc
<commit_msg>[contrib-guide] Adds note about filing troubleshooting bugs<commit_after>.. _doc_bugs:

============================
Reporting documentation bugs
============================

The Documentation team tracks all its work through bugs. This section includes
the detailed overview of documentation bugs specifics.

.. note::

   To work on documentation bugs, join the openstack-doc-bugs team on
   Launchpad. For more information, see :ref:`first_timers`.

Go through the triaging process and look for possible duplicate bugs
before working on a bug. Do not work on a documentation bug until it is set to
`Confirmed`. Ideally, another person has to confirm the bug for you. Once the
changes are made in a patch, they are reviewed and approved, just like other
OpenStack code.

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 projects
<https://bugs.launchpad.net/openstack/+bugs?field.tag=documentation>`_.

Filing a bug
~~~~~~~~~~~~

Bugs differ depending on:

* The way they are filed:

  * Manually
  * Automatically (through the DocImpact flag)

* The required changes:

  * Fix spelling errors or formatting
  * Update existing content
  * Add new content

.. important::

   Do not file a bug with troubleshooting issues. If you are experiencing
   problems with your environment, and you are following the installation
   tutorials, seek assistance from the relevant team and operations
   specialists on IRC,
   `ask.openstack.org <https://ask.openstack.org/en/questions/>`_
   or the OpenStack mailing list.

   For more information about the relevant IRC channels, see the
   `OpenStack IRC wiki <https://wiki.openstack.org/wiki/IRC>`_.

   For more information about the OpenStack mailing list, see the
   `Mailing lists wiki <https://wiki.openstack.org/wiki/Mailing_Lists>`_.

   A bug should be filed only if the documentation itself is found to be
   incorrect.

**DocImpact**

When adding code that affects documentation (for example, to add a new
parameter), the developer adds a DocImpact flag. This flag automatically
files a bug in the system explaining what needs to be done. For more
information, see `Documentation/DocImpact
<https://wiki.openstack.org/wiki/Documentation/DocImpact>`_.

Launchpad projects and repositories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Documentation team uses two projects for tracking documentation bugs
across OpenStack:

* Launchpad bug area `openstack-manuals
  <https://bugs.launchpad.net/openstack-manuals>`_ is the default one for
  doc bugs and should be used for docs sourced from these repositories:

  * openstackdocstheme
  * openstack-doc-tools
  * openstack-manuals
  * security-doc

{'fraction_non_alphanumeric': 0.09863655730720068, 'fraction_numerical': 0.0, 'mean_word_length': 4.4976580796252925, 'pattern_counts': {'":': 0, '<': 12, '<?xml version=': 0, '>': 12, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3212678', 'n_tokens_mistral': 1258, 'n_tokens_neox': 1175, 'n_words': 570}