openstack/ironic
Code Issues Proposed changes

Update Launchpad references to Storyboard

Browse Source 
While old launchpad links will still work,
we have process and contributor documentation
that needed to be updated.

Change-Id: I0890e09ba75a6ac8644ce2bea9292aab5b55cfb5
This commit is contained in:
Julia Kreger
2018-03-26 12:08:45 -07:00
parent 9143ec7baf
commit 006950e3ca
5 changed files with 68 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.rst
View File

@@ -5,6 +5,6 @@ you must follow the steps documented at:
Pull requests submitted through GitHub will be ignored. Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub: Bugs should be filed in StoryBoard, not GitHub:
https://bugs.launchpad.net/ironic https://storyboard.openstack.org/#!/project/943

4
README.rst
View File

@@ -31,8 +31,8 @@ Project resources
* APIs: https://developer.openstack.org/api-ref/baremetal/index.html * APIs: https://developer.openstack.org/api-ref/baremetal/index.html
Project status, bugs, and requests for feature enhancements (RFEs) are tracked Project status, bugs, and requests for feature enhancements (RFEs) are tracked
on Launchpad: in StoryBoard:
https://launchpad.net/ironic https://storyboard.openstack.org/#!/project/943
For information on how to contribute to ironic, see For information on how to contribute to ironic, see
https://docs.openstack.org/ironic/latest/contributor https://docs.openstack.org/ironic/latest/contributor

115
doc/source/contributor/code-contribution-guide.rst
View File

@@ -18,8 +18,8 @@ help you get your accounts set up in Launchpad and Gerrit, familiarize you with
the workflow for the OpenStack continuous integration and testing systems, and the workflow for the OpenStack continuous integration and testing systems, and
help you with your first commit. help you with your first commit.
LaunchPad Project LaunchPad
----------------- ---------
Most of the tools used for OpenStack require a launchpad.net ID for Most of the tools used for OpenStack require a launchpad.net ID for
authentication. authentication.
@@ -27,7 +27,18 @@ authentication.
.. seealso:: .. seealso::
* https://launchpad.net * https://launchpad.net
* https://launchpad.net/ironic
Storyboard
----------
The ironic project moved from Launchpad to `StoryBoard
<https://storyboard.openstack.org/>`_ for work and task tracking.
This provides an aggregate view called a "Project Group"
and individual "Projects". A good starting place is the
`project group <https://storyboard.openstack.org/#!/project_group/75>`_
representing the whole of the ironic community, as opposed to
the `ironic project <https://storyboard.openstack.org/#!/project/943>`_
storyboard which represents ironic as a repository.
Related Projects Related Projects
---------------- ----------------
@@ -37,18 +48,18 @@ developed by the same community.
.. seealso:: .. seealso::
* https://launchpad.net/bifrost * https://docs.openstack.org/bifrost/latest/
* https://launchpad.net/ironic-inspector * https://docs.openstack.org/ironic-inspector/latest/
* https://launchpad.net/ironic-lib * https://docs.openstack.org/ironic-lib/latest/
* https://launchpad.net/ironic-python-agent * https://docs.openstack.org/ironic-python-agent/latest/
* https://launchpad.net/python-ironicclient * https://docs.openstack.org/python-ironicclient/latest/
* https://launchpad.net/python-ironic-inspector-client * https://docs.openstack.org/python-ironic-inspector-client/latest/
Project Hosting Details Project Hosting Details
----------------------- -----------------------
Bug tracker Bug tracker
https://bugs.launchpad.net/ironic https://storyboard.openstack.org/#!/project/943
Mailing list (prefix Subject line with ``[ironic]``) Mailing list (prefix Subject line with ``[ironic]``)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
@@ -65,81 +76,77 @@ Code Review
Adding New Features Adding New Features
=================== ===================
Starting with the Mitaka development cycle, Ironic tracks new features using Ironic tracks new features using RFEs (Requests for Feature Enhancements)
RFEs (Requests for Feature Enhancements) instead of blueprints. These are bugs instead of blueprints. These are stories with 'rfe' tag, and they should
with 'rfe' tag, and they should be submitted before a spec or code is proposed. be submitted before a spec or code is proposed.
When a member of `ironic-drivers launchpad team
<https://launchpad.net/~ironic-drivers/+members>`_ decides that the proposal When a member of the `ironic-core team <https://review.openstack.org/#/admin/groups/165,members>`_
is worth implementing, a spec (if needed) and code should be submitted, decides that the proposal is worth implementing, a spec (if needed) and code
referencing the RFE bug. Contributors are welcome to submit a spec and/or code should be submitted, referencing the RFE task or story ID number. Contributors
before the RFE is approved, however those patches will not land until the RFE are welcome to submit a spec and/or code before the RFE is approved, however
is approved. those patches will not land until the RFE is approved.
Feature Submission Process Feature Submission Process
-------------------------- --------------------------
#. Submit a bug report at https://bugs.launchpad.net/ironic/+filebug. #. Submit a bug report on the `ironic StoryBoard
There are two fields that must be filled: 'summary' and <https://storyboard.openstack.org/#!/project/943>`_.
'further information'. The 'summary' must be brief enough to fit in one There are two fields that must be filled: 'Title' and
line: if you can’t describe it in a few words it may mean that you are 'Description'. 'Tasks' can be added and are associated with a project.
If you can’t describe it in a sentence or two, it may mean that you are
either trying to capture more than one RFE at once, or that you are having either trying to capture more than one RFE at once, or that you are having
a hard time defining what you are trying to solve at all. a hard time defining what you are trying to solve at all. This may also be
a sign that your feature may require a specification document.
#. Describe the proposed change in the 'further information' field. The #. Describe the proposed change in the 'Description' field. The
description should provide enough details for a knowledgeable developer to description should provide enough details for a knowledgeable developer to
understand what is the existing problem in the current platform that needs understand what is the existing problem in the current platform that needs
to be addressed, or what is the enhancement that would make the platform to be addressed, or what is the enhancement that would make the platform
more capable, both from a functional and a non-functional standpoint. more capable, both from a functional and a non-functional standpoint.
#. Submit the bug, add an 'rfe' tag to it and assign yourself or whoever is #. Submit the story, add an 'rfe' tag to it and assign yourself or whoever is
going to work on this feature. going to work on this feature.
#. As soon as a member of the ironic-drivers team acknowledges the bug, it #. As soon as a member of the team acknowledges the story,
will be moved into the 'Triaged' state. The importance will be set to we will move the story to the 'Review' state. As time goes on, Discussion
'Wishlist' to signal the fact that the report is indeed a feature and there about the RFE, and whether to approve it will occur.
is no severity associated to it. Discussion about the RFE, and whether to
approve it, happens in bug comments while in the 'Triaged' state.
#. The ironic-drivers team will evaluate the RFE and may advise the submitter #. Contributors will evaluate the RFE and may advise the submitter to file a
to file a spec in ironic-specs to elaborate on the feature request, in case spec in the ironic-specs repository to elaborate on the feature request.
the RFE requires extra scrutiny, more design discussion, etc. For the spec Typically this is when an RFE requires extra scrutiny, more design
submission process, please see the `Ironic Specs Process`_. discussion, etc. For the spec submission process, please see the
`Ironic Specs Process`_. A specific task should be created to track the
creation of a specification.
#. If a spec is not required, once the discussion has happened and there is #. If a spec is not required, once the discussion has happened and there is
positive consensus among the ironic-drivers team on the RFE, the RFE is positive consensus among the ironic-core team on the RFE, the RFE is
'approved', and its tag will move from 'rfe' to 'rfe-approved'. This means 'approved', and its tag will move from 'rfe' to 'rfe-approved'. This means
that the feature is approved and the related code may be merged. that the feature is approved and the related code may be merged.
#. If a spec is required, the spec must be submitted (with the bug properly #. If a spec is required, the spec must be submitted (with a new task as part
referenced as 'Partial-Bug' in the commit message), reviewed, and merged of the story referenced as 'Task' in the commit message), reviewed, and merged
before the RFE will be 'approved' (and the tag changed to 'rfe-approved'). before the RFE will be 'approved' (and the tag changed to 'rfe-approved').
#. The bug then goes through the usual process -- first to 'In progress' when #. The tasks then goes through the usual process -- first to 'Review' when
the spec/code is being worked on, then 'Fix Released' when it is the spec/code is being worked on, then 'Merged' when it is
implemented. implemented.
#. If the RFE is rejected, the ironic-drivers team will move the bug to #. If the RFE is rejected, the ironic-core team will move the story to
"Won't Fix" status. "Invalid" status.
Change Tracking Change Tracking
--------------- ---------------
When working on an RFE, please be sure to tag your commits properly: When working on an RFE, please be sure to tag your commits properly:
"Partial-Bug: #xxxx" or "Related-Bug: #xxxx" for intermediate commits for the "Story: #xxxx" or "Task: #xxxx". It is also helpful to set a consistent
feature, and "Closes-Bug: #xxxx" for the final commit. It is also helpful to review topic, such as "story/xxxx" for all patches related to the RFE.
set a consistent review topic, such as "bug/xxxx" for all patches related to
the RFE.
If the RFE spans across several projects (e.g. ironic and python-ironicclient), If the RFE spans across several projects (e.g. ironic and python-ironicclient),
but the main work is going to happen within ironic, please use the same bug for but the main work is going to happen within ironic, please use the same story
all the code you're submitting, there is no need to create a separate RFE in for all the code you're submitting, there is no need to create a separate RFE
every project. in every project.
.. note:: Currently the Ironic bug tracker is managed by the open .. note:: **RFEs may only be approved by members of the ironic-core team**.
'ironic-bugs' team, not the ironic-drivers team. This means that
anyone may edit bug details, and there is room to game the system
here. **RFEs may only be approved by members of the ironic-drivers
team**.
Managing Change Sets Managing Change Sets
-------------------- --------------------

4
doc/source/contributor/faq.rst
View File

@@ -88,14 +88,14 @@ updated
but we will only allow it in extenuating circumstances. (It can be but we will only allow it in extenuating circumstances. (It can be
updated by *only* updating the file in that branch. DO NOT update the file updated by *only* updating the file in that branch. DO NOT update the file
in master and cherry-pick it. If you do, `see how the mess was cleaned up in master and cherry-pick it. If you do, `see how the mess was cleaned up
<https://bugs.launchpad.net/ironic/+bug/1670401>`_.) <https://storyboard.openstack.org/#!/story/1670401>`_.)
...get a decision on something? ...get a decision on something?
------------------------------- -------------------------------
You have an issue and would like a decision to be made. First, make sure You have an issue and would like a decision to be made. First, make sure
that the issue hasn't already been addressed, by looking at documentation, that the issue hasn't already been addressed, by looking at documentation,
bugs, specifications, or asking. Information and links can be found on the stories, specifications, or asking. Information and links can be found on the
`Ironic wiki`_ page. `Ironic wiki`_ page.
There are several ways to solicit comments and opinions: There are several ways to solicit comments and opinions:

2
doc/source/contributor/index.rst
View File

@@ -68,7 +68,7 @@ Testing Network Integration
--------------------------- ---------------------------
In order to test the integration between the Bare Metal and Networking In order to test the integration between the Bare Metal and Networking
services, support has been added to `devstack <https://launchpad.net/devstack>`_ services, support has been added to `devstack <https://docs.openstack.org/devstack/latest/>`_
to mimic an external physical switch. Here we include a recommended to mimic an external physical switch. Here we include a recommended
configuration for devstack to bring up this environment. configuration for devstack to bring up this environment.