storyboard/doc/source/gui/worklists.rst
Kendall Nelson 234ac1b68b 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
2018-06-25 14:38:30 -07:00

3.4 KiB

Using Worklists

Basic Workflow

Here's an example workflow for a project team:

  1. Make a worklist:

    image

  2. Subscribe to it:

    image

  3. Next, make a list of tasks you care about from existing stories, by adding cards to the worklist:

    image

    image

  4. and save it:

    image

It will look something like this:

image

Setting Permissions

You can select users who are allowed to move things on the worklist. To do so, edit the worklist:

image

and add people whom you want to be able to interact with the worklist, eg: to add users:

image

Setting Priorities

You can drag and drop tasks in order of priority

image

This lets anyone who views your worklist see the priority of your tasks, and anyone who subscribes to it see the priority of those tasks when viewing affected stories.

Populating a Worklist Manually

You can also do it the other way round, adding existing stories to a worklist you care about as you see them:

Browse to a story with a task you care about, and click the arrow next to that task to expand detailed information and options for it:

image

Then the 'add to worklist' button:

image

And add the task to your chosen worklist for team priorities:

image

image

If you go back to your worklist, that task will now be there!

image

On a story, tasks that feature in subscribed worklists will appear on the top-right, along with their position in the worklist:

image

If you are not subscribed to any worklists containing tasks from the story (or the story itself), that space will be empty, since we only display this information to people who want it:

image

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

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

It is possible to subscribe to email notifications for worklists, so that you can be kept up to date on changes in priority. These notifications can be toggled in the profile preferences (person icon on navbar, near the bottom) and are separate from the main email notifications, to avoid things getting spammy. :)