diff --git a/doc/source/storyboard.rst b/doc/source/storyboard.rst new file mode 100644 index 0000000000..8d16cf901c --- /dev/null +++ b/doc/source/storyboard.rst @@ -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 `_ + * `StoryBoard 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! diff --git a/doc/source/systems.rst b/doc/source/systems.rst index 80b604c10c..9563d6db81 100644 --- a/doc/source/systems.rst +++ b/doc/source/systems.rst @@ -27,6 +27,7 @@ Major Systems wiki git openstackid + storyboard .. NOTE(dhellmann): These projects were not listed above, or in any other toctree, which breaks the build. It's not clear why they were