x/development-proposals
Code Issues Proposed changes

Rework content to publish it

Browse Source 
Change the content so that we can publish it to
specs.openstack.org/openstack/development-proposals - and then retire
this repository.

Fix some formatting problems, remove not used files from documentation
and update docs to mention retirement of repository.

Once this change is merged, the repository can be retired.

Change-Id: I2e28d847fe98d8951c6fb2406838f3774d9e653d
This commit is contained in:
Andreas Jaeger 2018-08-31 09:54:43 +02:00
parent 3f0c1f0a07
commit 23ff6aea85
12 changed files with 37 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -1,19 +1,27 @@
Working with OpenStack User Stories
===================================
OpenStack User Stories Status
=============================
This repository is a working space for the `OpenStack Product WG <https://wiki.openstack.org/wiki/ProductTeam>`_ and contains user stories and their associated trackers.
This repository was the working space for the `OpenStack Product WG
<https://wiki.openstack.org/wiki/ProductTeam>`_ and contains user
stories and their associated trackers.
The OpenStack Product WG has been `abandoned in February 2018
<http://lists.openstack.org/pipermail/user-committee/2018-February/002599.html>`_,
this content is published for reference only.
Product WG / OpenStack User Stories Documentation
=================================================
The /doc/source/workflow directory contains details about the Product WG process.
The /doc/source/workflow directory contains details about the Product
WG process.
The `HACKING.rst <HACKING.rst>`_ file contains details on how to contribute user stories.
The `HACKING.rst <HACKING.rst>`_ file contains details on how to
contribute user stories.
:Product WG Taxonomy Overview: doc/source/workflow/taxonomy.rst
:Product WG Workflow: doc/source/workflow/workflow.rst
:Active User Story Template: user-story-template.rst
:Tracker Template: user-story-tracker.json
The rendered user stories are available in
`OpenStack User Stories <http://specs.openstack.org/openstack/openstack-user-stories/>`_.
The rendered user stories are available in `OpenStack User Stories
<http://specs.openstack.org/openstack/development-proposals/>`_.

3
development-proposals/parking/doc-usecase-snippet.rst
View File

@ -47,11 +47,13 @@ These user stories utilize the standard `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I would like to quickly learn commands and
structure associated with each project. In addition, I would like to have
snippets for common use cases that I can modify for my own purposes.
.. _Rey the Cloud Operator: http://docs.openstack.org/contributor-guide/ux-ui-guidelines/ux-personas/cloud-ops.html
.. _OpenStack UX Personas: http://docs.openstack.org/contributor-guide/ux-ui-guidelines/ux-personas.html
Usage Scenario Examples
+++++++++++++++++++++++
#. Rey has decided to explore the OpenStackClient (OSC) as an alternative to
using the individual APIs
#. Rey opens the OpenStack documentation page
@ -75,6 +77,7 @@ None.
*External References*
+++++++++++++++++++++
* `Operator OpenStackClient Validation Study (Barcelona 2016)`_
* `Operator OpenStackClient Validation Study (Austin 2016)`_

4
doc/source/contributing.rst
View File

@ -1,4 +0,0 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst

1
doc/source/development-proposals Symbolic link
View File

@ -0,0 +1 @@
../../development-proposals/

15
doc/source/index.rst
View File

@ -1,13 +1,10 @@
.. OpenStack User Stories documentation master file
Contents:
===========================
Development Proposal Status
===========================
For progress status, please refer Feature Tracker
at http://featuretracker.openstack.org
.. include:: ../../README.rst
==================================
Development Proposal Specification
@ -30,6 +27,16 @@ Other Proposals In Draft/Pending
development-proposals/parking/*
========
Workflow
========
.. toctree::
:glob:
:maxdepth: 1
workflow/*
==================
Indices and tables
==================

12
doc/source/installation.rst
View File

@ -1,12 +0,0 @@
============
Installation
============
At the command line::
$ pip install openstack-user-stories
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv openstack-user-stories
$ pip install openstack-user-stories

1
doc/source/readme.rst
View File

@ -1 +0,0 @@
.. include:: ../../README.rst

125
doc/source/tracker_overview.rst
View File

@ -1,125 +0,0 @@
======================================
Product WG User Story Tracker Overview
======================================
This file provides an overview of the fields that should be included
when building a new tracker using the `sample tracker template <https://github.com/openstack/openstack-user-stories/blob/master/user-story-tracker.json>`_ located in this repository.
Hierarchy of tracker data
-------------------------
::
[ User_Story_Tracker_ID ]
|
|
-------------
| |
| |
[ task ] [ task ]
|
[ cross-project spec ]
|
-----------
| |
[ project ] [ project ]
|
--------------
| |
[ spec ] [ blueprints ]
|
--------------
| |
[ blueprint ] [ blueprint ]
Each user story can consist of multiple tasks, cross-project spec per
task, multiple projects per task, spec per project, and multiple
blueprints per project.
Any field that requires ``status`` should be one of the following values:
- ``none`` (this item is not required for the task)
- ``pending`` (this item is required but has not been created)
- ``in-progress`` (this item is being implemented)
- ``complete`` (this item has been implemented)
Description of fields used in the tracker:
------------------------------------------
``id``: this field should be unique in the repository
``date:`` date the tracker was created in MM-DD-YYYY format
``description:`` user story title + " tracker"
``source``: URI (uniform resource identifier) for user story RST file
``status``: the first occurrence of status indicates the implementation status for
the overall user story
``tasks``: names of cross-project specs associated with user story (comma-delimited)
- each value in provided for "tasks" becomes a section under tasks_status
``cross-project spec``: URI for cross-project spec RST file
``gerrit-topic``: topic to be used for submitting code that implements the
cross-project spec
``xp_status``: indicates the implementation status for the overall task
``projects``: names of projects associated with this task/cross-project spec
- each value in provided for "projects" becomes a section under projects_status
``bp_name``: name of blueprint(s) that need to be implemented per project
``bp_status``: indicates the implementation status for for blueprint(s)
``spec``: URI for project spec RST file
``spec_status``: indicates the implementation status for the project spec
Example
-------
::
{
"id": "sample_tracker",
"date": "02-05-2016",
"description": "user-story tracker",
"source": "https://github.com/openstack/openstack-user-stories/blob/master/user-story-tracker.json",
"status": "in-progress",
"tasks": [
"cross-project-spec-name1"
],
"tasks_status": {
"cross-project-spec-name1": {
"cross-project spec": "https://github.com/openstack/openstack-specs/blob/master/specs/cross-project-spec-1.rst",
"gerrit-topic": "sample_tracker/cross_proj_1",
"xp_status": "in-progress",
"projects": [
"cinder",
"tacker"
],
"projects_status": {
"cinder": {
"blueprints": {
"cinder-bp-1": "pending",
"cinder-bp-2": "in-progress"
},
"spec": "https://github.com/openstack/cinder-specs/blob/master/specs/newton/cinder-spec-1.rst",
"spec_status": "in-progress"
},
"tacker": {
"blueprints": {
"tacker-bp-1": "pending"
},
"spec": "none",
"spec_status": "pending"
}
}
}
}
}

7
doc/source/usage.rst
View File

@ -1,7 +0,0 @@
========
Usage
========
To use openstack-user-stories in a project::
import openstack-user-stories

1
doc/source/user-stories
View File

@ -1 +0,0 @@
../../user-stories/

2
doc/source/workflow/taxonomy.rst
View File

@ -23,7 +23,7 @@ The Product Working Group will follow agile terminology/methodology in a loose s
**Task**: A task is a lower-level requirements item that captures a sub-unit, or step, that is necessary to complete a user story. Tasks are usually generated by the development team working on the user story.
.. image:: https://github.com/openstack/openstack-user-stories/doc/source/images/agile_overview.jpg
.. image:: ../images/agile_overview.jpg
Good resources for additional information related to these terms:

9
doc/source/workflow/workflow.rst
View File

@ -1,5 +1,6 @@
Workflow
=======
========
Where Feature/Improvements Come From
------------------------------------
Feature or improvement ideas typically start from a few ways:
@ -9,7 +10,8 @@ Feature or improvement ideas typically start from a few ways:
* A patch within a project that's recognized as benefiting other projects.
How to Propose Feature/Improvements in OpenStack
-----------------------------------------------
------------------------------------------------
Blueprints
^^^^^^^^^^
To formally propose a feature or improvement to an OpenStack project, you need
@ -72,13 +74,14 @@ assigned to oversee an idea cross-project with the following responsibilities:
for work to be carried out on. This will allow all development work in
`gerrit <https://review.openstack.org>`_ to be found easily with the topic
filter across the different projects.
4. Once enough consensus is met by the cross-project spec liaisons of the
5. Once enough consensus is met by the cross-project spec liaisons of the
necessary projects, the specification will be passed to the Technical
Committee for approval.
Tracking Feature/Improvement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. The Product Working Group Liaison should identify with each project involved
who will actually implement the feature/improvement.
2. Alignment with each project implementing the feature/improvement in the same