Jump to: navigation, search


Date: Wednesday, 17th December 2014

Time: Whenever you're awake!

Communications: #openstack-doc on the Freenode IRC Network

Goal: Triage at least 30 doc bugs in openstack-manuals and openstack-api-site.

How to Participate

  1. Before the day, try to become familiar with how to triage doc bugs by reading about our bug triaging guidelines.
  2. Make sure you have joined the doc bugs group in Launchpad: [[1]].
  3. Get to know the Cross-Project Liaison for Docs for each project by reading the list of Docs liaisons.
  4. On the day join #openstack-doc on the Freenode IRC Network so you can communicate with everyone.
  5. Pick up one or more of the tasks below:

Understanding Doc Bugs

  1. The Launchpad bug area openstack-manuals is the default for doc bugs and should be used for docs sourced from these repositories:
    • clouddocs-maven-plugin
    • openstack-doc-tools
    • openstack-manuals,
    • operations-guide
    • security-doc
  2. Launchpad bug area openstack-api-site is used for all the API repositories:
    • api-site (includes the API Complete Reference)
    • compute-api (going to openstack-attic)
    • identity-api (going to openstack-attic)
    • image-api (going to openstack-attic)
    • netconn-api (going to openstack-attic)
    • object-api (going to openstack-attic)
    • volume-api (going to openstack-attic)

Triaging Doc Bugs

The best thing you can do on a bug triaging day is to write comments on a doc bug that are detailed enough for anyone to walk up and create a fix. Ask for docs team or liaison help all day on IRC.

The lists of bugs are here:

  1. If you sense the bug is fairly easy or straightforward to fix once it is triaged, tag it with "low-hanging-fruit" to indicate someone could pick it up easily.
  2. If a bug is marked Confirmed, look closely at it, research it to see if you can triage it, then set it to Triaged.
  3. Most of our bugs are tagged meaningfully, but do add tags if you think they are missing. Here are some tag ideas.

If you know a part of OpenStack well, write any suggested text or hints on how to doc something up on a particular bug. Here's a breakdown by category:

We also tag doc tooling bugs in these Launchpad projects with: doc-builds or doc-tools. These are not a priority for triaging. We want to focus on content doc bugs.

Close old fixed bugs

Old bugs are nasty. Even when they are long dead, they clog bug views and render the lists unusable. Just look at old bugs and check if they still apply ! If they don't, close them as FixReleased (if you can pinpoint when they were fixed) or Invalid (if you can't).

Getting Help

If you need assistance with knowing where something goes, fixing build failures, or approving reviews, please contact the following people on #openstack-doc during the allotted time.

Note that if you can't triage a doc bug, just move on to the next one! With nearly 600 doc bugs there are plenty to go around.

UTC Mentors Timezone handover
2300 Names here Australia
0000 Names here
0100 Names here Asia
0200 Names here
0300 Names here
0400 Names here India
0500 Names here
0600 Names here
0700 Names here
0800 Names here Europe
1400 Names here US-East
1500 annegentle US-Central
1600 annegentle
1700 annegentle US-West
1800 annegentle
1900 annegentle
2000 annegentle
2100 annegentle
2200 Names here

Time zone conversions