Merge "Added documentation for StoryBoard"
This commit is contained in:
commit
fadf58cd71
doc/source
85
doc/source/storyboard.rst
Normal file
85
doc/source/storyboard.rst
Normal file
@ -0,0 +1,85 @@
|
|||||||
|
:title: StoryBoard
|
||||||
|
|
||||||
|
StoryBoard
|
||||||
|
##########
|
||||||
|
|
||||||
|
StoryBoard is the task and project tracking system both developed and used by
|
||||||
|
the OpenStack project. Some projects have already elected to move to
|
||||||
|
StoryBoard, however it is still considered in limited alpha and is not ready
|
||||||
|
for production use.
|
||||||
|
|
||||||
|
This section describes how StoryBoard is configured for use in the
|
||||||
|
OpenStack project and the tools used to manage that configuration.
|
||||||
|
|
||||||
|
At a Glance
|
||||||
|
===========
|
||||||
|
|
||||||
|
:Hosts:
|
||||||
|
* https://storyboard.openstack.org
|
||||||
|
:Puppet:
|
||||||
|
* https://git.openstack.org/cgit/openstack-infra/puppet-storyboard/tree/
|
||||||
|
* :file:`modules/openstack_project/manifests/storyboard.pp`
|
||||||
|
:Projects:
|
||||||
|
* https://git.openstack.org/cgit/openstack-infra/storyboard
|
||||||
|
* https://git.openstack.org/cgit/openstack-infra/storyboard-webclient
|
||||||
|
* https://git.openstack.org/cgit/openstack-infra/puppet-storyboard
|
||||||
|
:Configuration:
|
||||||
|
* :file:`modules/openstack_project/files/review.projects.yaml`
|
||||||
|
* :file:`modules/openstack_project/files/storyboard/superusers.yaml`
|
||||||
|
:Bugs:
|
||||||
|
* https://storyboard.openstack.org/#!/project/456
|
||||||
|
:Resources:
|
||||||
|
* `StoryBoard Documentation <http://ci.openstack.org/storyboard/>`_
|
||||||
|
* `StoryBoard Wiki <https://wiki.openstack.org/wiki/StoryBoard>`_
|
||||||
|
* `StoryBoard Roadmap <https://wiki.openstack.org/wiki/StoryBoard/Roadmap>`_
|
||||||
|
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
StoryBoard is installed and configured by Puppet, using the puppet module
|
||||||
|
developed for the project. See :ref:`sysadmin` for how Puppet is used to
|
||||||
|
manage OpenStack infrastructure systems.
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
=============
|
||||||
|
|
||||||
|
Much of StoryBoard's default configuration is managed from within infra/config
|
||||||
|
itself. To add a project, admin, or modify a team, please follow the
|
||||||
|
instructions below.
|
||||||
|
|
||||||
|
Adding a Project to StoryBoard
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
At this point, only OpenStack Infrastructure projects should be added to
|
||||||
|
StoryBoard, as key features such as release versioning are not yet
|
||||||
|
implemented.
|
||||||
|
|
||||||
|
Projects loaded into StoryBoard are handled from the same file that drives our
|
||||||
|
gerrit projects. Adding a new project is as simple as modifying a single
|
||||||
|
file and adding the line ``use-storyboard: true``:
|
||||||
|
|
||||||
|
``/modules/openstack_project/files/review.projects.yaml``::
|
||||||
|
|
||||||
|
- project: openstack-infra/storyboard
|
||||||
|
description: OpenStack Task Tracking API
|
||||||
|
use-storyboard: true
|
||||||
|
|
||||||
|
|
||||||
|
Adding an Admin to StoryBoard
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
StoryBoard administrators are handled from a single configuration file, and
|
||||||
|
are identified by OpenID. To add a new administator, simply add their
|
||||||
|
Launchpad OpenID string and email as follows:
|
||||||
|
|
||||||
|
``/modules/openstack_project/files/review.projects.yaml``::
|
||||||
|
|
||||||
|
- openid: https://login.launchpad.net/+id/LOLPONIES
|
||||||
|
email: pinkie.pie@example.com
|
||||||
|
|
||||||
|
|
||||||
|
Modifying a Team on StoryBoard
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
Teams are not yet supported. Stay tuned!
|
@ -27,6 +27,7 @@ Major Systems
|
|||||||
wiki
|
wiki
|
||||||
git
|
git
|
||||||
openstackid
|
openstackid
|
||||||
|
storyboard
|
||||||
|
|
||||||
.. NOTE(dhellmann): These projects were not listed above, or in any
|
.. NOTE(dhellmann): These projects were not listed above, or in any
|
||||||
other toctree, which breaks the build. It's not clear why they were
|
other toctree, which breaks the build. It's not clear why they were
|
||||||
|
Loading…
x
Reference in New Issue
Block a user