Add to & Reorganize StoryBoard GUI Docs

This patch does a little reorganization of the gui docs.
It adds a section solely focused on the creation and
functions of boards. It also adds a section on best
practices as we get a lot of questions about how things
should be done.

Change-Id: Id208d2edb754030a75ba2c1884fd8ef0b620a6af
This commit is contained in:
Kendall Nelson 2018-06-20 00:41:28 -07:00
parent f38f3bc98d
commit 234ac1b68b
10 changed files with 88 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

View File

@ -0,0 +1,36 @@
==============
Best Practices
==============
Organizing a Team
=================
#. Tags: Teams should decide on a list of tags they will be using and document
them. Examples: nova-m1, bug, driver, low-hanging-fruit. The tags that are
important to your team will depend heavily on how you like to organize work.
If your team targets milestones, you might need tags for the milestones. If
your team has a lot of driver work and you have a tag for each vendor, you
should use those. In the end, the only thing that is important is that they
are clear and well documented.
#. Boards: Two of the most common ways of organizing works in boards are-
#. Using a board to organize work in a kanban style- worklists for new,
backlog, in progress, and done. Stories are arranged in the list by
priority- higher priority items closer to the top.
#. A board per release with each worklist being a separate milestone.
Stories that are in the worklist are organized by priority.
#. Worklists: Worklists can exist in a board or on their own. Most often, they
are used in the context of boards.
Organizing Your Work
====================
Its possible, even likely, that your personal priorities differ from
that of the project(s) you are working on. You might have to balance
and organize work you are involved in between several projects and
SIGs. This is why StoryBoard supports the creation of worklists and
boards by anyone.

28
doc/source/gui/boards.rst Normal file
View File

@ -0,0 +1,28 @@
=============
Using Boards
=============
Basic Workflow
==============
Here's an example board for a project team:
#. Make a board:
.. image:: _assets/create_board.png
:width: 95%
#. Add Worklists(lanes).
.. image:: _assets/add_board_worklists.png
:width: 95%
#. Add other owners to the board:
.. image:: _assets/add_board_owner.png
:width: 95%
#. Add users to the board:
.. image:: _assets/add_board_user.png
:width: 95%

View File

@ -85,6 +85,9 @@ criterai for an automatic worklist:
.. image:: _assets/example-automatic-worklist-filters.png
For more information about how to create and edit worklists, see
:ref: 'this documentation <worklists>'.
We also have boards, which are akin to collections of
worklists. Here's an example:
@ -110,6 +113,9 @@ owners. Users can move and delete cards, but only owners can delete
lanes or change the metadata of the board itself (eg: its title or
description).
For documentation on how to create boards, add users/owners, etc
:ref: 'that can be located here <boards>'.
Complex Priority
================

View File

@ -94,6 +94,21 @@ Once you have a team worklist, you can link the worklist on irc or on
the mailing list, etc, wherever it's most visible, and invite people
to subscribe!
Automatic Worklists
===================
You can make standalone automatic worklists or automatic worklists that
exist in a board. You set up criteria when you create the worklist to
funnel the relevant stories in the worklist. Criteria can be set up to
filter tasks or stories into an automatic worklist.
.. image:: _assets/automatic_worklist_criteria.png
If you have a board of automatic worklists, you can't manually move
the stories around from list to list, the criteria that makes it
appear in a certain worklist has to change for it to move.
Worklist Notifications
======================

View File

@ -37,8 +37,10 @@ Using StoryBoard
:maxdepth: 1
How it Works <gui/theory>
Tasks, Stories, & Tags <gui/tasks_stories_tags>
Boards <gui/boards>
Worklists <gui/worklists>
Tasks, Stories, & Tags <gui/tasks_stories_tags>
Organizing Your Work: Best Practices <gui/best_practices>
Installation guides
-------------------