openstack/training-guides
Code Issues Proposed changes

[upstream-training] Use sphinx list-table for readability

Browse Source 
In some of the page has a list such as the following, in the
"launchpad" slide. It is not easy to read.

- item: item description
- other_item: other_item description

Fix it using the list-table of the sphinx, to improve the readability.
Target is the following secsions.

- Bug status
- Bug importance
- Bug tags
- Bug

Change-Id: Ie71a6f227d67d7a6e5d3f90f8e0f934ad21bb15d
Closes-Bug: #1480812
This commit is contained in:
Kenjiro Kosaka 2015-08-13 01:56:57 +00:00
parent 1cc1dba016
commit c559f21eeb
1 changed files with 80 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
doc/upstream-training/source/13-launchpad.rst
View File

@ -27,22 +27,37 @@ Blueprint
Bug status
==========
- New: The bug was just created
- Incomplete: The bug is waiting on input from the reporter
- Confirmed: The bug was reproduced or confirmed as a genuine bug
- Triaged: The bug comments contain a full analysis on how to properly fix the
issue
- In Progress: Work on the fix is in progress, bug has an assignee
- Fix Committed: The branch containing the fix was merged into master
- Fix Released: The fix is included in the milestone-proposed branch, a past
milestone or a past release
.. list-table::
:widths: 30 70
* - New
- The bug was just created
* - Incomplete
- The bug is waiting on input from the reporter
* - Confirmed
- The bug was reproduced or confirmed as a genuine bug
* - Triaged
- The bug comments contain a full analysis on how to properly fix the issue
* - In Progress
- Work on the fix is in progress, bug has an assignee
* - Fix Committed
- The branch containing the fix was merged into master
* - Fix Released
- The fix is included in the milestone-proposed branch, a past milestone or
a past release
Bug status
==========
- Invalid: This is not a bug
- Opinion: This is a valid issue, but it is the way it should be
- Won't Fix: This is a valid issue, but we don't intend to fix that
.. list-table::
:widths: 30 70
* - Invalid
- This is not a bug
* - Opinion
- This is a valid issue, but it is the way it should be
* - Won't Fix
- This is a valid issue, but we don't intend to fix that
Bug status
==========
@ -61,25 +76,30 @@ Bug status
Bug importance
==============
- Critical: Data corruption / complete failure affecting most users, no
workaround
- High: Data corruption / complete failure affecting most users, with
workaround
- Failure of a significant feature, no workaround
- Medium: Failure of a significant feature, with workaround
- Failure of a fringe feature, no workaround
- Low: Small issue with an easy workaround. Any other insignificant bug
- Wish list: Not really a bug, but a suggested improvement
- Undefined: Impact was not assessed yet
.. list-table::
:widths: 30 70
* - Critical
- Data corruption / complete failure affecting most users, no workaround
* - High
- Data corruption / complete failure affecting most users, with workwround.
Failure of a significant feature, no workaround
* - Medium
- Failure of a significant feature, with workaround.
Failure of a fringe feature, no workaround
* - Low
- Small issue with an easy workaround. Any other insignificant bug
* - Wishlist
- Not really a bug, but a suggested improvement
* - Undefined
- Impact was not assessed yet
Bug importance
==============
- Critical
- High
- Failure
- Medium
- Failure
- Low
- Wishlist
- Undefined
@ -87,31 +107,50 @@ Bug importance
Bug tags
========
- low-hanging-fruit: Bugs that are easy to fix, ideal for beginners to get
familiar with the workflow and to have their first contact with the code in
OpenStack development.
- documentation: Bug is about documentation or has an impact on documentation.
- i18n: Translations / i18n issues.
- security: Fix for the bug would make OpenStack more resilient to future
security issues.
- ops: Fix for the bug would significantly ease OpenStack operation.
.. list-table::
:widths: 35 65
* - low-hanging-fruit
- Bugs that are easy to fix, ideal for beginners to get familiar with the
workflow and to have their first contact with the code in OpenStack
development.
* - documentation
- Bug is about documentation or has an impact on documentation.
* - i18n
- Translations / i18n issues.
* - security
- Fix for the bug would make OpenStack more resilient to future security
issues.
* - ops
- Fix for the bug would significantly ease OpenStack operation.
Bug tags
========
- SERIES-rc-potential: During the SERIES pre-release period, mark the bug as a
potential release-critical blocker
- SERIES-backport-potential: Mark the bug as a potential backport target to a
specific SERIES (grizzly, havana...)
- Per project tags: https://wiki.openstack.org/wiki/BugTags
.. list-table::
:widths: 35 65
* - SERIES-rc-potential
- During the SERIES pre-release period, mark the bug as a potential
release-critical blocker
* - SERIES-backport-potential
- Mark the bug as a potential backport target to a specific SERIES
(grizzly, havana...)
* - Per project tags
- https://wiki.openstack.org/wiki/BugTags
Bug
===
- Assigned To: The person currently working to fix this bug. Must be set by
In progress stage.
- Milestone: The milestone we need to fix the bug for, or the
milestone/version it was fixed in.
.. list-table::
:widths: 30 70
* - Assigned To
- The person currently working to fix this bug. Must be set by In progress
stage.
* - Milestone
- The milestone we need to fix the bug for, or the milestone/version it
was fixed in.
Bug report
==========