From e0eae0b42ca0b12cbd7ec7ffea9a7ee644b6a0aa Mon Sep 17 00:00:00 2001 From: Adam Williamson Date: Sep 22 2023 07:06:45 +0000 Subject: Improvements to Change process documentation This updates the Change announcement SOP to be in-line with the current practice followed by @amoloney (in the absence of clearer guidance from FESCo for the Discourse changes, so far). It adds a new SOP for dropping Changes (which is different from deferring them), and extends the PgM Guide Changes page and the top-level Changes SOP page to link to all the individual SOPs (a couple were missing in each case) and also explain how a Change's lifecycle is ultimately completed (in the Release Day SOP). Signed-off-by: Adam Williamson --- diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 1f2fc68..1b98d04 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -38,6 +38,7 @@ **** xref:pgm_guide/sop/changes-process.adoc[Processing Changes] **** xref:pgm_guide/sop/changes-contingency.adoc[Evaluating Changes contingency plans] **** xref:pgm_guide/sop/changes-defer.adoc[Deferring Changes] +**** xref:pgm_guide/sop/changes-drop.adoc[Dropping Changes] *** xref:pgm_guide/sop/prioritized_bugs.adoc[Prioritized bugs] *** xref:pgm_guide/sop/blocker-email.adoc[Blocker status email] *** xref:pgm_guide/sop/spins-keepalive.adoc[Spins keepalive] diff --git a/modules/ROOT/pages/pgm_guide/changes.adoc b/modules/ROOT/pages/pgm_guide/changes.adoc index de30fda..16c0e1d 100644 --- a/modules/ROOT/pages/pgm_guide/changes.adoc +++ b/modules/ROOT/pages/pgm_guide/changes.adoc @@ -5,6 +5,6 @@ We need to know about disrupting changes coming to the next release to set the s For more details on Change Process, see the xref:program_management::changes_policy.adoc[Changes Policy]. == Responsibilities -The Program Manager's key responsibility is to maintain the Changes Process — xref:pgm_guide/sop/changes-announce.adoc[announcements], xref:pgm_guide/sop/changes-submit.adoc[submission], xref:pgm_guide/sop/changes-process.adoc[processing], xref:pgm_guide/sop/changes-contingency.adoc[tracking]. +The Program Manager's key responsibility is to maintain the Changes Process — xref:pgm_guide/sop/changes-announce.adoc[announcements], xref:pgm_guide/sop/changes-submit.adoc[submission], xref:pgm_guide/sop/changes-process.adoc[processing], xref:pgm_guide/sop/changes-contingency.adoc[tracking], xref:pgm_guide/sop/changes-defer.adoc[deferring], xref:pgm_guide/sop/changes-drop.adoc[dropping]. Completed Changes are closed as part of the xref:pgm_guide/sop/release_day.adoc[Release Day SOP]. One of the main responsibilities is helping Change owners through the submission process. The Program Manager works on the xref:program_management::changes_policy.adoc[Changes Policy] with the xref:fesco::index.adoc[Fedora Engineering Steering Committee] (FESCo), Working Groups and other Fedora teams and bodies (documentation, marketing, etc.). diff --git a/modules/ROOT/pages/pgm_guide/sop/changes-announce.adoc b/modules/ROOT/pages/pgm_guide/sop/changes-announce.adoc index 44a9a28..fbd3e13 100644 --- a/modules/ROOT/pages/pgm_guide/sop/changes-announce.adoc +++ b/modules/ROOT/pages/pgm_guide/sop/changes-announce.adoc @@ -16,18 +16,25 @@ Proposals are sent to the development community for public comment. .. Put the _Owner_ and _Email_ fields are one line instead of multiple. This will make the BZ creation easier later. . Compose an email as follows. -.. Set the `to:` field to `devel-announce@lists.fedoraproject.org` -.. Set the `cc:` field to `devel@lists.fedoraproject.org` +.. Set the `to:` field to `devel-announce@lists.fedoraproject.org` and the `reply-to:` field to `devel@lists.fedoraproject.org` .. Set the subject to _F proposal: (<System-Wide|Self-Contained> Change proposal)_. This is to make it clear to external readers that this is a _proposal_ and not a final decision. .. In the body of the email, add the URL to the wiki page -.. Copy the "this is a propsal" content from the wiki page into the body. +.. Copy the "this is a proposal" content from the wiki page into the body. Again, this is so that it's unambigiously clear. .. Copy the wiki source into the body, removing comments and performing other readability cleanup as you deem necessary. . Send the email +. Create a post in the https://discussion.fedoraproject.org/c/project/changes/89[Discourse Change Proposals category]. +.. Set the topic to _F<NN> Change Proposal: <title> (<System-Wide|Self-Contained>)_. +.. Place a link to the wiki page and a link to the devel-announce post at the top of the post. +.. Then copy the "this is a proposal" content from the wiki page into the post. +.. Copy the contents of the wiki page into the post, applying Markdown formatting as appropriate. You can try converting the wiki text to markdown by saving it as `change.txt` and running `pandoc -f mediawiki -w markdown /change.txt -o /change.md`, but it will not work perfectly and will still require manual adjustment. +. Reply to your original announcement email, again with `reply-to` set to `devel@lists.fedoraproject.org`, with the content: +`The discussion thread to provide feedback for this change proposal can be found here: https://(link_to_discourse_post)` . Update the wiki page .. Replace the `ChangeReadyForWrangler` category with `ChangeAnnounced` -.. Add a link to the https://lists.fedoraproject.org/archives/list/devel%40lists.fedoraproject.org/[devel thread] in the _Current status_ section +.. Add a link to the https://lists.fedoraproject.org/archives/list/devel-announce%40lists.fedoraproject.org/[devel-announce thread] in the _Current status_ section, with the title "Announced" +.. Add a link to the Discourse thread in the same section, with the title "Discussion Thread" . Add an entry to the _Changes_ table for the release in xref:pgm_guide/sop/fridays_fedora_facts.adoc[Friday's Fedora Facts] Once you have sent the email, you do not need to further participate in the discussion. diff --git a/modules/ROOT/pages/pgm_guide/sop/changes-drop.adoc b/modules/ROOT/pages/pgm_guide/sop/changes-drop.adoc new file mode 100644 index 0000000..e3ac378 --- /dev/null +++ b/modules/ROOT/pages/pgm_guide/sop/changes-drop.adoc @@ -0,0 +1,26 @@ += Changes (Dropping) SOP + +This document describes the process of dropping xref:changes_policy.adoc[Changes]. + +== Timing/trigger + +This process is triggered by FESCo or the owner deciding to drop a change. +Often, this is the result of a Change having significant issues, or a maintainer losing interest. +For the Change to be revived it must go through the full process again, starting by being updated and moved back to ChangeReadyForWrangler. + +== Process + +. **Reply to the mailing list thread**, only if the proposal has not yet been submitted to FESCo. +. **Close the FESCo ticket**, if one has been opened and is still open. +. **Update the Change's wiki page.** +Clear the "Targeted Release". +Change the category to "ChangePageIncomplete". +Add a header at the top: `{{admon/important|Change dropped|This Change is dropped. It can be re-proposed if interest in it revives.}}` +It is a good idea to also include an appropriate reference - a link to a FESCo ticket or meeting log, or a message from the Change owner. +. **Update the tracking bug, if it exists.** +Clear the _Blocks_ field. +Reset the version to "rawhide". +Close the bug as DEFERRED. +. **Close the Release Notes issue, if it exists.** +. **Re-run the Change processing scripts for the old and new target release.** +See the xref:pgm_guide/sop/changes.adoc#update_changeset[instructions]. diff --git a/modules/ROOT/pages/pgm_guide/sop/changes.adoc b/modules/ROOT/pages/pgm_guide/sop/changes.adoc index d79ca3c..ac2ead4 100644 --- a/modules/ROOT/pages/pgm_guide/sop/changes.adoc +++ b/modules/ROOT/pages/pgm_guide/sop/changes.adoc @@ -27,7 +27,15 @@ See the xref:pgm_guide/sop/changes-contingency.adoc[Changes (Contingency) SOP]. === Defer Changes -See the xref:pgm_guide/sop/changes-defer:w.adoc[Changes (Announce) SOP]. +See the xref:pgm_guide/sop/changes-defer:w.adoc[Changes (Deferring) SOP]. + +=== Drop Changes + +See the xref:pgm_guide/sop/changes-drop:w.adoc[Changes (Dropping) SOP]. + +=== Completing Changes + +See the xref:pgm_guide/sop/release_day.adoc[Release Day SOP]. === Update ChangeSet page [#update_changeset]