Reorganize Docs
There were two disjointed user guides which are unified in this patch. In the future, they will live in the webclient repo instead of here, but for the time being we need a more unified front for our users. Change-Id: Icb5b9a46b8e45518392de617ba9eee3fb9bf04fd
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 95 KiB |
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 103 KiB After Width: | Height: | Size: 103 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
@ -1,8 +1,8 @@
|
||||
================
|
||||
Using StoryBoard
|
||||
================
|
||||
======================
|
||||
Tasks, Stories, & Tags
|
||||
======================
|
||||
|
||||
This manual is a guide for StoryBoard users to navigate the webclient.
|
||||
This manual is a guide for StoryBoard users to navigate the usage of tasks, stories, and tags in the webclient.
|
||||
|
||||
The OpenStack StoryBoard webclient can be accessed 'here <https://storyboard.openstack.org/>'_.
|
||||
|
@ -52,7 +52,7 @@ There is also a much more fully-featured and interactive commandline
|
||||
StoryBoard interface named boartty in progress over here, that jeblair
|
||||
wrote on a plane:
|
||||
|
||||
.. image:: boartty-3.png
|
||||
.. image:: _assets/boartty-3.png
|
||||
|
||||
The long and short of it is, if you know how to display data from a
|
||||
REST API, you can display data from a StoryBoard instance.
|
||||
@ -74,7 +74,7 @@ Worklists are arbitrary groupings of stories and/or tasks with
|
||||
whatever title the user wants. Each 'item' (story or task) is placed
|
||||
on a 'card' on the worklist. Here is an example:
|
||||
|
||||
.. image:: example-worklist.png
|
||||
.. image:: _assets/example-worklist.png
|
||||
|
||||
A worklist can be handy as a personal todo list. Anyone can make a
|
||||
worklist, and the creator can decide who (if anyone) else can view and
|
||||
@ -83,12 +83,12 @@ automatically populate it with stories or tasks that fulfil some
|
||||
criteria (eg: 'assigned to Alice'. Here are some example filter
|
||||
criterai for an automatic worklist:
|
||||
|
||||
.. image:: example-automatic-worklist-filters.png
|
||||
.. image:: _assets/example-automatic-worklist-filters.png
|
||||
|
||||
We also have boards, which are akin to collections of
|
||||
worklists. Here's an example:
|
||||
|
||||
.. image:: example-board.png
|
||||
.. image:: _assets/example-board.png
|
||||
|
||||
You can name 'lanes' (lists) in the board what you want, and either
|
||||
populate them as a visualisation of some data by making them
|
@ -9,26 +9,26 @@ Here's an example workflow for a project team:
|
||||
|
||||
#. Make a worklist:
|
||||
|
||||
.. image:: create-worklist.png
|
||||
.. image:: _assets/create-worklist.png
|
||||
|
||||
#. Subscribe to it:
|
||||
|
||||
.. image:: subscribe-worklist.png
|
||||
.. image:: _assets/subscribe-worklist.png
|
||||
|
||||
#. Next, make a list of tasks you care about from existing stories, by
|
||||
adding cards to the worklist:
|
||||
|
||||
.. image:: add-card-to-worklist.png
|
||||
.. image:: _assets/add-card-to-worklist.png
|
||||
|
||||
.. image:: add-task-to-worklist.png
|
||||
.. image:: _assets/add-task-to-worklist.png
|
||||
|
||||
#. and save it:
|
||||
|
||||
.. image:: save-worklist.png
|
||||
.. image:: _assets/save-worklist.png
|
||||
|
||||
It will look something like this:
|
||||
|
||||
.. image:: worklist-after-adding-tasks.png
|
||||
.. image:: _assets/worklist-after-adding-tasks.png
|
||||
|
||||
Setting Permissions
|
||||
===================
|
||||
@ -36,19 +36,19 @@ Setting Permissions
|
||||
You can select users who are allowed to move things on the
|
||||
worklist. To do so, edit the worklist:
|
||||
|
||||
.. image:: edit-worklist-perms-1.png
|
||||
.. image:: _assets/edit-worklist-perms-1.png
|
||||
|
||||
and add people whom you want to be able to interact with the worklist,
|
||||
eg: to add users:
|
||||
|
||||
.. image:: edit-worklist-perms-2.png
|
||||
.. image:: _assets/edit-worklist-perms-2.png
|
||||
|
||||
Setting Priorities
|
||||
==================
|
||||
|
||||
You can drag and drop tasks in order of priority
|
||||
|
||||
.. image:: drag-n-drop-on-worklist.png
|
||||
.. image:: _assets/drag-n-drop-on-worklist.png
|
||||
|
||||
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
|
||||
@ -63,32 +63,32 @@ 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:: add-task-to-worklist-1.png
|
||||
.. image:: _assets/add-task-to-worklist-1.png
|
||||
|
||||
Then the 'add to worklist' button:
|
||||
|
||||
.. image:: add-task-to-worklist-2.png
|
||||
.. image:: _assets/add-task-to-worklist-2.png
|
||||
|
||||
And add the task to your chosen worklist for team priorities:
|
||||
|
||||
.. image:: add-task-to-worklist-3.png
|
||||
.. image:: _assets/add-task-to-worklist-3.png
|
||||
|
||||
.. image:: add-task-to-worklist-4.png
|
||||
.. image:: _assets/add-task-to-worklist-4.png
|
||||
|
||||
If you go back to your worklist, that task will now be there!
|
||||
|
||||
.. image:: add-task-to-worklist-5.png
|
||||
.. image:: _assets/add-task-to-worklist-5.png
|
||||
|
||||
On a story, tasks that feature in subscribed worklists will appear on
|
||||
the top-right, along with their position in the worklist:
|
||||
|
||||
.. image:: worklist-subs-on-story.png
|
||||
.. image:: _assets/worklist-subs-on-story.png
|
||||
|
||||
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:: story-with-no-worklist-subs.png
|
||||
.. image:: _assets/story-with-no-worklist-subs.png
|
||||
|
||||
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
|
@ -36,7 +36,9 @@ Using StoryBoard
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
gui/manual
|
||||
How it Works <gui/theory>
|
||||
Tasks, Stories, & Tags <gui/tasks_stories_tags>
|
||||
Worklists <gui/worklists>
|
||||
|
||||
Installation guides
|
||||
-------------------
|
||||
@ -52,13 +54,6 @@ Maintenance guides
|
||||
|
||||
maintenance/upgrading
|
||||
|
||||
User guide
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
user/index
|
||||
|
||||
Launchpad Migration guides
|
||||
--------------------------
|
||||
|
@ -1,8 +0,0 @@
|
||||
============
|
||||
User Guide
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
|
||||
theory
|
||||
worklists
|