From 6f5e393a9bb4f8c1acc8fe90ff1c102b355cd083 Mon Sep 17 00:00:00 2001 From: ricolin Date: Sat, 5 May 2018 12:42:04 +0800 Subject: [PATCH] Add StoryBoard migration docs and releasenote Heat curent bug/bluepint reports are migrated from Launchpad to StoryBoard [1]. If you like to create a new story(a bug or a bluepint), please file it under [2]. For more detail, please reference [3]. This change applied to all heat projects. This patch Add documents and guideline link to StoryBoard. Also add releasenote to showing migration message. [1] https://storyboard.openstack.org/#!/project_group/82 [2] https://storyboard.openstack.org/#!/project/989 [3] https://etherpad.openstack.org/p/Heat-StoryBoard-Migration-Info Change-Id: I7c7dab88d269f92c66b3f68352a6913aa244fdfc --- README.rst | 10 +++ doc/source/contributing/blueprints.rst | 69 ++++++++----------- doc/source/man/heat-db-setup.rst | 5 +- doc/source/man/heat-keystone-setup-domain.rst | 4 +- doc/source/man/heat-keystone-setup.rst | 5 +- doc/source/man/heat-manage.rst | 4 +- ...igrate-to-storyboard-36c90857d3167322.yaml | 10 +++ tools/dashboards/heat.dash | 7 +- 8 files changed, 61 insertions(+), 53 deletions(-) create mode 100644 releasenotes/notes/migrate-to-storyboard-36c90857d3167322.yaml diff --git a/README.rst b/README.rst index 0264a6f50e..f569937f8c 100644 --- a/README.rst +++ b/README.rst @@ -35,6 +35,16 @@ Python client * Documentation: https://docs.openstack.org/python-heatclient/latest * Source: https://git.openstack.org/cgit/openstack/python-heatclient +Report a Story (a bug/blueprint) +-------------------------------- + +If you'd like to report a Story (we used to call a bug/blueprint), you can +report it under Report a story in +`Heat's StoryBoard `_. +If you must report the story under other sub-project of heat, you can find +them all in `Heat StoryBoard Group `_. +if you encounter any issue. + References ---------- * https://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html diff --git a/doc/source/contributing/blueprints.rst b/doc/source/contributing/blueprints.rst index a860438b81..087178f895 100644 --- a/doc/source/contributing/blueprints.rst +++ b/doc/source/contributing/blueprints.rst @@ -11,9 +11,14 @@ Please note that we use a template for spec submissions. Please use the `_. It is not required to fill out all sections in the template. +You have to create a Story in StoryBoard `heat storyboard +`_. And create tasks that +fit with the plan to implement this spec (A task to link to a patch in gerrit). + Spec Notes ---------- + There are occasions when a spec is approved and the code does not land in the cycle it was targeted for. For these cases, the workflow to get the spec into the next release is as below: @@ -29,67 +34,51 @@ priorities. Heat Spec Lite -------------- -Lite specs are small feature requests tracked as Launchpad bugs, with status -'Wishlist' and tagged with 'spec-lite' tag. These allow for submission and -review of these feature requests before code is submitted. +Lite specs are small feature requests tracked as StoryBoard stories, and tagged +with 'spec-lite' and 'priority-wishlist' tag. These allow for submission +and review of these feature requests before code is submitted. These can be used for small features that don’t warrant a detailed spec to be proposed, evaluated, and worked on. The team evaluates these requests as it evaluates specs. -Once a `spec-lite` bug has been approved/triaged as a +Once a `spec-lite` story has been approved/triaged as a Request for Enhancement(RFE), it’ll be targeted for a release. -The workflow for the life of a spec-lite in Launchpad is as follows: +The workflow for the life of a spec-lite in StoryBoard is as follows: -* File a bug with a small summary of what the requested change is and - tag it as `spec-lite`. -* The bug is triaged and importance changed to `Wishlist`. -* The bug is evaluated and marked as `Triaged` to announce approval or - to `Won't fix` to announce rejection or `Invalid` to request a full - spec. -* The bug is moved to `In Progress` once the code is up and ready to +* File a story with a small summary of what the requested change is and + tag it as `spec-lite` and `priority-wishlist`. +* Create tasks that fit to your plan in story. +* The story is evaluated and marked with tag as `triaged` to announce + approval or `Invalid` to request a full spec or it's not a valided task. +* The task is moved to `Progress` once the code is up and ready to review. -* The bug is moved to `Fix Committed` once the patch lands. +* The task is moved to `Merged` once the patch lands. +* The story is moved to `Merged` once all tasks merged. -In summary: +The drivers team will discuss the following story reports in IRC meetings: -+--------------+-----------------------------------------------------------------------------+ -|State | Meaning | -+==============+=============================================================================+ -|New | This is where spec-lite starts, as filed by the community. | -+--------------+-----------------------------------------------------------------------------+ -|Triaged | Drivers - Move to this state to mean, "you can start working on it" | -+--------------+-----------------------------------------------------------------------------+ -|Won't Fix | Drivers - Move to this state to reject a lite-spec. | -+--------------+-----------------------------------------------------------------------------+ -|Invalid | Drivers - Move to this state to request a full spec for this request | -+--------------+-----------------------------------------------------------------------------+ - -The drivers team will discuss the following bug reports in IRC meetings: - -* `heat RFE's `_ -* `python-heatclient RFE's `_ +* `heat stories `_ +* `heat story filter `_ Lite spec Submission Guidelines ------------------------------- -When a bug is submitted, there are two fields that must be filled: ‘summary’ -and ‘further information’. The ‘summary’ must be brief enough to fit in one -line. +When a story is submitted, there is field that must be filled: ‘Description’. -The ‘further information’ section must be a description of what you would like +The ‘Description’ section must be a description of what you would like to see implemented in heat. The description should provide enough details for a knowledgeable developer to understand what is the existing problem and what’s the proposed solution. -Add `spec-lite` tag to the bug. +Add `spec-lite` tag to the story. -Lite spec from existing bugs ----------------------------- +Lite spec from existing stories +------------------------------- -If there's an already existing bug that describes a small feature suitable for -a spec-lite, add a `spec-lite` tag to the bug. There is no need to create a new -bug. The comments and history of the existing bug are important for it's review. +If there's an already existing story that describes a small feature suitable for +a spec-lite, add a `spec-lite` tag to the story. There is no need to create a new +story. The comments and history of the existing story are important for its review. diff --git a/doc/source/man/heat-db-setup.rst b/doc/source/man/heat-db-setup.rst index 905698a2dc..e04388cff9 100644 --- a/doc/source/man/heat-db-setup.rst +++ b/doc/source/man/heat-db-setup.rst @@ -67,5 +67,6 @@ EXAMPLES BUGS ==== -Heat bugs are managed through Launchpad -`OpenStack Heat Bugs `__ + +Heat bugs are managed through StoryBoard +`OpenStack Heat Stories `__ diff --git a/doc/source/man/heat-keystone-setup-domain.rst b/doc/source/man/heat-keystone-setup-domain.rst index 5b194c8632..5fc42ed5c9 100644 --- a/doc/source/man/heat-keystone-setup-domain.rst +++ b/doc/source/man/heat-keystone-setup-domain.rst @@ -103,5 +103,5 @@ EXAMPLES BUGS ==== -Heat bugs are managed through Launchpad -`OpenStack Heat Bugs `__ +Heat bugs are managed through StoryBoard +`OpenStack Heat Stories `__ diff --git a/doc/source/man/heat-keystone-setup.rst b/doc/source/man/heat-keystone-setup.rst index a9afc2325c..1b866b4276 100644 --- a/doc/source/man/heat-keystone-setup.rst +++ b/doc/source/man/heat-keystone-setup.rst @@ -30,5 +30,6 @@ EXAMPLES BUGS ==== -Heat bugs are managed through Launchpad -`OpenStack Heat Bugs `__ + +Heat bugs are managed through StoryBoard +`OpenStack Heat Stories `__ diff --git a/doc/source/man/heat-manage.rst b/doc/source/man/heat-manage.rst index e9ad40a7d6..d29f11ab2f 100644 --- a/doc/source/man/heat-manage.rst +++ b/doc/source/man/heat-manage.rst @@ -73,5 +73,5 @@ connection and logging. BUGS ==== -* Heat issues are tracked in Launchpad so you can view or report bugs here - `OpenStack Heat Bugs `__ +Heat bugs are managed through StoryBoard +`OpenStack Heat Stories `__ diff --git a/releasenotes/notes/migrate-to-storyboard-36c90857d3167322.yaml b/releasenotes/notes/migrate-to-storyboard-36c90857d3167322.yaml new file mode 100644 index 0000000000..f022bab79b --- /dev/null +++ b/releasenotes/notes/migrate-to-storyboard-36c90857d3167322.yaml @@ -0,0 +1,10 @@ +--- +prelude: | + Heat current bug/blueprint reports have migrated from Launchpad to + `storyboard`_. If you would like to create a new story (a bug or a + blueprint), please file it under the `Heat project`_. This change + applies to `all heat projects/repos`_. + + .. _storyboard: https://storyboard.openstack.org/#!/project_group/82 + .. _Heat project: https://storyboard.openstack.org/#!/project/989 + .. _all heat projects/repos: https://storyboard.openstack.org/#!/project_group/82 diff --git a/tools/dashboards/heat.dash b/tools/dashboards/heat.dash index 57725c70ac..a272b987d0 100644 --- a/tools/dashboards/heat.dash +++ b/tools/dashboards/heat.dash @@ -11,11 +11,8 @@ foreach = (project:openstack/heat OR project:openstack/heat-agents OR [section "Heat Specs"] query = project:openstack/heat-specs -[section "Bug Fixes"] -query = intopic:^bug/.* - -[section "Blueprints"] -query = message:"Blueprint" +[section "Stories & Bug Fixes"] +query = (intopic: ^story/.* OR intopic: ^bug/.* OR intopic: ^bp/.*) [section "Needs Feedback (Changes older than 5 days that have not been reviewed by anyone)"] query = NOT label:Code-Review>=1 NOT label:Code-Review<=-1 age:5d