eaa74543de
The zuul and zuulv3 docs need to be merged, but that seemed like too much for this. Also, the 3rd party CI doc is out of date, but in this patch only removed sections that linked to docs or files that don't exist anymore. Change-Id: Ie5497edd762d2146165608f3227b0bac88a913df
90 lines
2.8 KiB
ReStructuredText
90 lines
2.8 KiB
ReStructuredText
:title: StoryBoard
|
|
|
|
.. _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:
|
|
* https://opendev.org/opendev/puppet-storyboard/tree/
|
|
* :cgit_file:`modules/openstack_project/manifests/storyboard.pp`
|
|
:Projects:
|
|
* https://opendev.org/opendev/storyboard
|
|
* https://opendev.org/opendev/storyboard-webclient
|
|
* https://opendev.org/opendev/puppet-storyboard
|
|
:Configuration:
|
|
* :config:`gerrit/projects.yaml`
|
|
* :cgit_file:`modules/openstack_project/files/storyboard/superusers.yaml`
|
|
:Bugs:
|
|
* https://storyboard.openstack.org/#!/project/456
|
|
:Resources:
|
|
* `StoryBoard Documentation <http://docs.openstack.org/infra/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
|
|
=============
|
|
|
|
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 administrator, simply add their
|
|
Launchpad OpenID string and email as follows:
|
|
|
|
``:config:`gerrit/projects.yaml```::
|
|
|
|
- openid: https://login.ubuntu.com/+id/LOLPONIES
|
|
email: pinkie.pie@example.com
|
|
|
|
|
|
Modifying a Team on StoryBoard
|
|
------------------------------
|
|
|
|
Currently, only admin users can add users to a team; this is accessible
|
|
from the admin submenu menu. Teams have no special permissions yet;
|
|
stay tuned!
|