[openstack-dev] [Fuel][Docs] Triage rules for documentation bugs

Dmitry Borodaenko dborodaenko at mirantis.com
Wed Mar 18 23:37:45 UTC 2015

I've added following bug importance guidelines for documentation bugs
in the public Fuel wiki [0]:

* Critical = following the instructions from documentation can cause
outage or data loss
* High = documentation includes information that is not true, or
instructions that yield the advertised outcome
* Medium = important information is missing from documentation (e.g.
new feature description)
* Low = additional information would improve reader's understanding of a feature
* Wishlist = cosmetic formatting and grammar issues

The "How to contribute" page doesn't include the definition of our
code freeze process, so I don't have a good place to publish it yet.
In short, code freeze doesn't apply the same way to fuel-docs
repository, documentation changes including bugfixes can be worked on
throughout code freeze all the way until the release week.

More generic bug importance criteria based on functionalily still
apply. For example, the definition of High importance as "specific
hardware, configurations, or components are unusable and there's no
workaround; or everything is broken but there's a workaround" means
that when a feature is not usable without documentation, lack of
documentation for a feature brings the bug importance up to High.

[0] https://wiki.openstack.org/wiki/Fuel/How_to_contribute#Confirm_and_triage_bugs

Dmitry Borodaenko

More information about the OpenStack-dev mailing list