Ian Wienand 882b730fdf Update to openstackdocstheme

This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c

2018-06-25 11:19:43 +10:00

2.9 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.

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

Projects

Configuration

gerrit/projects.yaml
:cgit_file:`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

The default superusers configuration of StoryBoard is managed from within infra/system-config. The rest of the configuration is on projects-config. To add a project, admin, or modify a team, please follow the instructions below.

Adding a Project to StoryBoard

Note

As cross-project work should be tracked in the same task-tracker, those wishing to set up new projects in StoryBoard should check about their specific circumstances in #openstack-infra.

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:

:config:`gerrit/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: