From 65b8895e8a1af9f2da8e64f66da43848857018d9 Mon Sep 17 00:00:00 2001 From: Jay Faulkner Date: Mon, 15 May 2023 13:58:57 -0700 Subject: [PATCH] Update docs: Ironic uses launchpad now Ironic switched to launchpad. Ensure our docs point contributors to the correct location. Change-Id: Ifa75c75741dd4a584bc2cb972eb4726c4c48d064 --- README.rst | 2 +- api-ref/source/conf.py | 2 +- doc/source/admin/drivers/ipmitool.rst | 2 +- doc/source/contributor/bugs.rst | 27 ++++++------- doc/source/contributor/community.rst | 23 ++++++----- doc/source/contributor/contributing.rst | 52 ++++++++++--------------- releasenotes/source/conf.py | 2 +- 7 files changed, 47 insertions(+), 63 deletions(-) diff --git a/README.rst b/README.rst index 4941d63c33..ec3817c58d 100644 --- a/README.rst +++ b/README.rst @@ -26,7 +26,7 @@ Project resources * Documentation: https://docs.openstack.org/ironic/latest * Source: https://opendev.org/openstack/ironic -* Bugs: https://storyboard.openstack.org/#!/project/943 +* Bugs: https://bugs.launchpad.net/ironic/+bugs * Wiki: https://wiki.openstack.org/wiki/Ironic * APIs: https://docs.openstack.org/api-ref/baremetal/index.html * Release Notes: https://docs.openstack.org/releasenotes/ironic/ diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 98de456273..a98ffa33bc 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -38,7 +38,7 @@ extensions = [ ] openstackdocs_repo_name = 'openstack/ironic' -openstackdocs_use_storyboard = True +openstackdocs_use_storyboard = False openstackdocs_auto_name = False # If extensions (or modules to document with autodoc) are in another directory, diff --git a/doc/source/admin/drivers/ipmitool.rst b/doc/source/admin/drivers/ipmitool.rst index cbdf6183d9..9840e812db 100644 --- a/doc/source/admin/drivers/ipmitool.rst +++ b/doc/source/admin/drivers/ipmitool.rst @@ -279,7 +279,7 @@ synchronization process, and record this value if not already set. While similar issues may exist when setting the boot mode and target boot device in other vendors' BMCs, we are not aware of them at present. Should you encounter such an issue, please feel free to report this via -`Storyboard `_, and be sure to include +`Launchpad `_, and be sure to include the ``chassis bootparam get 5`` output value along with the ``mc info`` output from your BMC. diff --git a/doc/source/contributor/bugs.rst b/doc/source/contributor/bugs.rst index 6f02a62d14..56cf75ad4b 100644 --- a/doc/source/contributor/bugs.rst +++ b/doc/source/contributor/bugs.rst @@ -1,28 +1,21 @@ Bug Reporting and Triaging Guide ================================ -StoryBoard +Launchpad ---------- -All ironic projects use StoryBoard_ for tracking both bugs and enhancement -requests (RFE). The `ironic project group`_ lists all our projects. +All Ironic projects use Launchpad_ for tracking bugs. .. note:: - Ironic is developed as part of OpenStack and therefore uses - the ``openstack/`` namespace. + Ironic projects formerly used Storyboard_ for tracking bugs. Since April + 2023, we have switched to Launchpad_ for bugtracking. -StoryBoard is somewhat different from traditional bug tracking -systems because every *story* is not linked to a project itself, but rather -through its *tasks*. A story represents an issue you are facing or an -enhancement you want to see, while tasks represent individual action items -which can span several projects. When creating a story, you'll also need to -create the first task. If unsure, create a task against ``openstack/ironic``. Reporting Guide --------------- We are constantly receiving a lot of requests, so it's important to file a -meaningful story for it to be acted upon. A good story: +meaningful one for it to be acted upon. A good request: * specifies **why** a change is needed. In case of a bug - what you expected to happen. @@ -56,13 +49,17 @@ meaningful story for it to be acted upon. A good story: An enhancement request additionally: * benefits the overall project, not just one consumer. If you have a case that - is specific to your requirements, think about ways to make ironic extensible + is specific to your requirements, think about ways to make Ironic extensible to be able to cover it. * does not unnecessary increase the project scope. Consider if your idea can be - implemented without changing ironic or its projects, maybe it actually + implemented without changing Ironic or its projects, maybe it actually should? +* should specify if you are willing to perform the work to enhance Ironic + yourself, of if you're submitting a request to for the project team to + executed your requested enhancement. + Triaging Guide -------------- @@ -129,7 +126,7 @@ the following cases: As usual, common sense should be applied when closing stories. .. _StoryBoard: https://storyboard.openstack.org -.. _ironic project group: https://storyboard.openstack.org/#!/project_group/ironic +.. _Launchpad: https://bugs.launchpad.net/ironic/+bugs .. _bifrost: https://docs.openstack.org/bifrost .. _spec: https://specs.openstack.org/openstack/ironic-specs/ .. _weekly meeting: https://wiki.openstack.org/wiki/Meetings/Ironic diff --git a/doc/source/contributor/community.rst b/doc/source/contributor/community.rst index 9c0d05344c..838636a4e6 100644 --- a/doc/source/contributor/community.rst +++ b/doc/source/contributor/community.rst @@ -9,7 +9,7 @@ Useful Links ============ Bug/Task tracker - https://storyboard.openstack.org/#!/project/openstack/ironic + https://bugs.launchpad.net/ironic/+bugs Code Hosting https://opendev.org/openstack/ironic @@ -20,6 +20,9 @@ Code Review Weekly Meeting Agenda https://wiki.openstack.org/wiki/Meetings/Ironic#Agenda_for_next_meeting +Ironic Contributors' Whiteboard + https://etherpad.opendev.org/p/IronicWhiteBoard + Asking Questions ================ @@ -53,28 +56,24 @@ that we don't miss it. Reporting Bugs ============== +See :doc:`bugs` for more details on how we track bugs. + LaunchPad --------- Most of the tools used for OpenStack require a Launchpad_ ID for -authentication. Ironic previously used to track work on Launchpad, -but we have not done so since migrating to Storyboard_. +authentication. Ironic tracks bugs via Launchpad. .. _Launchpad: https://launchpad.net Storyboard ---------- -The ironic project moved from Launchpad to `StoryBoard -`_ 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 `_ -representing the whole of the ironic community, as opposed to -the `ironic project `_ -storyboard which represents ironic as a repository. +The Ironic project moved from `StoryBoard +`_ for work and task tracking in +April, 2023. Ironic bugs in storyboard may remain valid, but there +should not be additional issues filed there. -See :doc:`bugs` for more details on how we track bugs. Contributing Code ================= diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index ea6554dc02..f6d94bb3fd 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -55,21 +55,19 @@ be submitted before a spec or code is proposed. When a member of the `ironic-core team `_ decides that the proposal is worth implementing, a spec (if needed) and code -should be submitted, referencing the RFE task or story ID number. Contributors +should be submitted, referencing the RFE task or bug number. Contributors are welcome to submit a spec and/or code before the RFE is approved, however those patches will not land until the RFE is approved. Feature Submission Process -------------------------- -#. Submit a bug report on the `ironic StoryBoard - `_. - There are two fields that must be filled: 'Title' and - '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 - 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. +#. Submit a bug report on `Launchpad + `_. + If you can't describe your feature 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 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 'Description' field. The description should provide enough details for a knowledgeable developer to @@ -77,12 +75,16 @@ Feature Submission Process to be addressed, or what is the enhancement that would make the platform more capable, both from a functional and a non-functional standpoint. -#. Submit the story, add an 'rfe' tag to it and assign yourself or whoever is +#. Submit the bug, add an 'rfe' tag to it and assign yourself or whoever is going to work on this feature. -#. As soon as a member of the team acknowledges the story, - we will move the story to the 'Review' state. As time goes on, Discussion - about the RFE, and whether to approve it will occur. +#. As soon as a member of the team acknowledges the bug, + we will move it to the 'Review' state. As time goes on, Discussion + about the RFE, and whether to approve it will occur. If the RFE has not + been triaged and you'd like it to recieve immediate attention, add it to + the Open Discussion section of our + `weekly meeting agenda `, + and, timezone permitting, attend the meeting to advocate for your RFE. #. Contributors will evaluate the RFE and may advise the submitter to file a spec in the ironic-specs repository to elaborate on the feature request. @@ -100,36 +102,22 @@ Feature Submission Process 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'). -#. The tasks then goes through the usual process -- first to 'Review' when - the spec/code is being worked on, then 'Merged' when it is - implemented. - #. If the RFE is rejected, the ironic-core team will move the story to "Invalid" status. Change Tracking --------------- -We track our stories and tasks in Storyboard. - -https://storyboard.openstack.org/#!/project/ironic - - -When working on an RFE, please be sure to tag your commits properly: -"Story: #xxxx" or "Task: #xxxx". It is also helpful to set a consistent -review topic, such as "story/xxxx" for all patches related to the RFE. - -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 story -for all the code you're submitting, there is no need to create a separate RFE -in every project. +Please ensure work related to a bug or RFE is tagged with the bug. This +generally is a "Closes-bug", "Partial-bug" or "Related-bug" tag as described +in the +`Git Commit messages guide ``. .. note:: **RFEs may only be approved by members of the ironic-core team**. .. note:: While not strictly required for minor changes and fixes, it is highly preferred by the Ironic community that any change - which needs to be backported, have a recorded Story and Task in - Storyboard. + which needs to be backported, have a recorded bug. Managing Change Sets -------------------- diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index ada491a3cd..c97cbd3aec 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -48,7 +48,7 @@ except ImportError: openstackdocstheme = None openstackdocs_repo_name = 'openstack/ironic' -openstackdocs_use_storyboard = True +openstackdocs_use_storyboard = False openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory.