diff --git a/doc/source/_assets/task_tracking/LP-bp.png b/doc/source/_assets/task_tracking/LP-bp.png new file mode 100644 index 0000000..1522bb6 Binary files /dev/null and b/doc/source/_assets/task_tracking/LP-bp.png differ diff --git a/doc/source/_assets/task_tracking/LP-bug-2.png b/doc/source/_assets/task_tracking/LP-bug-2.png new file mode 100644 index 0000000..2319d8a Binary files /dev/null and b/doc/source/_assets/task_tracking/LP-bug-2.png differ diff --git a/doc/source/_assets/task_tracking/LP-bug-3.png b/doc/source/_assets/task_tracking/LP-bug-3.png new file mode 100644 index 0000000..ed20296 Binary files /dev/null and b/doc/source/_assets/task_tracking/LP-bug-3.png differ diff --git a/doc/source/_assets/task_tracking/LP-bug.png b/doc/source/_assets/task_tracking/LP-bug.png new file mode 100644 index 0000000..972a785 Binary files /dev/null and b/doc/source/_assets/task_tracking/LP-bug.png differ diff --git a/doc/source/_assets/task_tracking/LP-overview.png b/doc/source/_assets/task_tracking/LP-overview.png new file mode 100644 index 0000000..5da9ff4 Binary files /dev/null and b/doc/source/_assets/task_tracking/LP-overview.png differ diff --git a/doc/source/_assets/task_tracking/Launchpad.png b/doc/source/_assets/task_tracking/Launchpad.png new file mode 100644 index 0000000..7dd052d Binary files /dev/null and b/doc/source/_assets/task_tracking/Launchpad.png differ diff --git a/doc/source/_assets/task_tracking/Storyboard.png b/doc/source/_assets/task_tracking/Storyboard.png new file mode 100644 index 0000000..38f70cd Binary files /dev/null and b/doc/source/_assets/task_tracking/Storyboard.png differ diff --git a/doc/source/code-and-documentation/index.rst b/doc/source/code-and-documentation/index.rst index 7beae74..0e1d60d 100644 --- a/doc/source/code-and-documentation/index.rst +++ b/doc/source/code-and-documentation/index.rst @@ -10,3 +10,4 @@ Code & Documentation Contributor Guide /common/accounts /common/git /common/setup-gerrit + /common/task-tracking diff --git a/doc/source/common/task-tracking.rst b/doc/source/common/task-tracking.rst new file mode 100644 index 0000000..726ff16 --- /dev/null +++ b/doc/source/common/task-tracking.rst @@ -0,0 +1,108 @@ +############# +Task Tracking +############# + +.. note:: + + This section assumes you have completed :doc:`accounts` guide. + +What Task Trackers does OpenStack use? +====================================== + +Each project is different in the process of reporting bugs and planning new +features. There are however two main tools that projects use: Launchpad and +Storyboard. + +Storyboard +========== + +Storyboard is kanban style task tracking system created and maintained by +the community. It was designed API-first and was engineered to support the +coordination of cross project work. Items tracked are stories and tasks. +A story can be a bug or a new feature, while tasks are the smaller todo's +required to complete the story. + +For information on how to use storyboard, please go `here `_. + +.. image:: /_assets/task_tracking/Storyboard.png + :scale: 40 + +Launchpad +========= + +Launchpad is the original task tracker used by OpenStack projects to organize +and target work to milestones and releases. It uses UbuntuOne for +authentication as it is managed by Canonical. Items tracked are either bugs +or blueprints. + +.. image:: /_assets/task_tracking/Launchpad.png + :scale: 40 + + +**Blueprints** + +In Launchpad, a new feature is called a blueprint. To file a new blueprint, click the +'Register a blueprint' button on the right. + +On the next screen you are prompted to add details including its name and title. + +.. image:: /_assets/task_tracking/LP-overview.png + :scale: 30 + +These are different in that the name is what is used in the generated url and the +title is what displays when blueprints are listed out (name: new_ibm_driver +title: New IBM ISCSI Driver). The next most important part is the summary- a +description of the code change, where most of the details about the implementation +is. After that, there are several optional fields you may wish to fill in- a +specification url, assignee, drafter, and approver. The last two fields before +registering have default values- status and propose for a sprint. For most teams, +its typical to leave the default values. + +It is possible to update all of this information except the name and title after +the blueprint is registered. When you have finished filling out all of the +information you care to include, it is good to communicate with the project +team lead that you have filed a blueprint. + +.. image:: /_assets/task_tracking/LP-bp.png + :scale: 40 + + +**Bugs** + +Bugs are pretty self explanitory- some unexpected or unintended behavior of the +software. To report a bug you have found in Launchpad, click the 'Report a bug' +button from the project's overview page. + +To get the details of reporting the bug you fill in the summary line and click +'next'. + +.. image:: /_assets/task_tracking/LP-bug.png + :scale: 40 + +Based on the summary line, Launchpad will do a quick query to see if there has been +anything reported already that might be the same issue you are trying to report. +It is important to look through these to avoid filing duplicate bugs and creating +redundancies in the bug index. If you do not see a bug that sounds like the issue +you are reporting, you can click the 'No, I need to report a new bug' button. + +.. image:: /_assets/task_tracking/LP-bug-2.png + :scale: 40 + +After clicking that button, the further information field will appear along with the +'This bug is a security vulnerability' radio box. You can edit the summary line to +differentiate it from the other bugs Launchpad thought it was similar to, add details +like the setup you were using, what you were doing when you hit the unexpected +behavior, the error codes you encountered, etc. + +If the bug is related to a security vulnerability it is important to click the box to +alert the Vulnerability Management Team to the issue. When you feel you have added +all of the information needed, go ahead and submit the bug report. For more information +about the full process for reporting security vulnerabilties, please continue reading +`this page `_. + +.. image:: /_assets/task_tracking/LP-bug-3.png + :scale: 30 + +It is a good idea to check back on the bug routinely if you aren't actively working on +solving it to make sure people haven't asked for more information about the issue. If +someone has commented on the bug, try to respond with the details they need.