Michael Krotscheck dcfc973787 Added documentation for StoryBoard

It's probably about time we added this page, especially
so that we can point people at documentation when they ask
"how do I add a project to StoryBoard".

Change-Id: I6e82ad97ab2c7ba9862b359d5a72266736eea6d1

2014-09-11 14:35:33 -07:00

2.8 KiB

Raw Blame History

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/
modules/openstack_project/manifests/storyboard.pp

Projects

Configuration

modules/openstack_project/files/review.projects.yaml
modules/openstack_project/files/storyboard/superusers.yaml

Bugs

https://storyboard.openstack.org/#!/project/456

Resources

Installation

StoryBoard is installed and configured by Puppet, using the puppet module developed for the project. See 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: