Per #2156, tweak release acceptance testing wording and add dropdown …

…for updating the DTC website.
dtcenter · Sep 20, 2023 · 8449f4c · 8449f4c
1 parent ee59df3
commit 8449f4c
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 86 deletions.
diff --git a/docs/Release_Guide/release_steps/common/update_dtc_website.rst b/docs/Release_Guide/release_steps/common/update_dtc_website.rst
@@ -1,70 +1,74 @@
 Update DTC Website
 ------------------
 
-* Navigate to https://dtcenter.org and sign in to the Drupal interface.
+METplus software releases are announced on the `DTC website <https://dtcenter.org>`_.
+Add or update information about software releases on the website.
 
-* Navigate to the downloads page for the |projectRepo| repository at
-  https://dtcenter.org/community-code/metplus/download
+.. dropdown:: Instructions
 
-* Click on the **Edit** button to edit the Downloads page.
+  * Navigate to https://dtcenter.org and sign in to the Drupal interface.
 
-* Create a new **Software Release** for the newly released version by clicking
-  on **Add New Release**.
+  * Navigate to the downloads page for the |projectRepo| repository at
+    https://dtcenter.org/community-code/metplus/download
 
-  * For **Full Title of Release** type "|projectRepo| Version X.Y.Z".
+  * Click on the **Edit** button to edit the Downloads page.
 
-  * For **Related Community Code** select both the "METplus" and the "|projectName|"
-    options (For Macs, hold the Command key to select both).
+  * Create a new **Software Release** for the newly released version by clicking
+    on **Add New Release**.
 
-  * For **Version Label** type "|projectRepo| X.Y.Z-betaN".
+    * For **Full Title of Release** type "|projectRepo| Version X.Y.Z".
 
-  * Select the **Release Type** ("Recommended" for official or bugfix releases or
-    "Development" for development versions).
+    * For **Related Community Code** select both the "METplus" and the "|projectName|"
+      options (For Macs, hold the Command key to select both).
 
-  * Enter the **Release Date**.
+    * For **Version Label** type "|projectRepo| X.Y.Z-betaN".
 
-  * Click on **Add Code Download** then click **Add Link** to add links for each of the following:
+    * Select the **Release Type** ("Recommended" for official or bugfix releases or
+      "Development" for development versions).
 
-    * Add Link: |addTarfileStep|
+    * Enter the **Release Date**.
 
-    * Add Link: Link text should be "User's Guide" and the URL should be the top
-      level directory of the User's Guide hosted on the web. Beta releases can
-      use "develop" in the URL, but for official releases, please ensure the
-      link uses the branch name (e.g. main_vX.Y) as opposed to the tag name
-      (e.g. vX.Y.Z).  For example, use
-      "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT
-      "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/"
+    * Click on **Add Code Download** then click **Add Link** to add links for each of the following:
 
-    * Add Link: Link text should be "Existing Builds and Docker" and the URL
-      should be the latest Existing Builds page, i.e.
-      https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds
-      (If creating a new official release, be sure to add a new *Existing Builds
-      and Docker* page, if one was not already created.)
+      * Add Link: |addTarfileStep|
+
+      * Add Link: Link text should be "User's Guide" and the URL should be the top
+        level directory of the User's Guide hosted on the web. Beta releases can
+        use "develop" in the URL, but for official releases, please ensure the
+        link uses the branch name (e.g. main_vX.Y) as opposed to the tag name
+        (e.g. vX.Y.Z).  For example, use
+        "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT
+        "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/"
+
+      * Add Link: Link text should be "Existing Builds and Docker" and the URL
+        should be the latest Existing Builds page, i.e.
+        https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds
+        (If creating a new official release, be sure to add a new *Existing Builds
+        and Docker* page, if one was not already created.)
 
-  * In the **Release Notes** text box provide a direct link to the
-    *release-notes.html* file in the User's Guide.
+    * In the **Release Notes** text box provide a direct link to the
+      *release-notes.html* file in the User's Guide.
 
-  * Click on **Create Release**.
+    * Click on **Create Release**.
 
-  * Update the existing releases, as needed.
+    * Update the existing releases, as needed.
 
-    * For a development release, ensure the "Release Type" is set to
-      **Development** and change any previous **Development** versions to
-      **Other**.
+      * For a development release, ensure the "Release Type" is set to
+        **Development** and change any previous **Development** versions to
+        **Other**.
 
-    * For a bugfix or official release, change any previous
-      **Recommended** versions to **Other**.
+      * For a bugfix or official release, change any previous
+        **Recommended** versions to **Other**.
 
-    * For an official release, remove the corresponding development
-      releases.
+      * For an official release, remove the corresponding development
+        releases.
 
-  * Edit the "Coordinated METplus Version X.Y" software release.
+    * Edit the "Coordinated METplus Version X.Y" software release.
 
-    * For a bugfix release, update the existing link and text in
-      the "Coordinated METplus-X.Y" release section with the
-      X.Y.Z+1 information.
-
-  * |otherWebsiteUpdates|
+      * For a bugfix release, update the existing link and text in
+        the "Coordinated METplus-X.Y" release section with the
+        X.Y.Z+1 information.
 
-  * Click on **Save** at the bottom of the page.
+    * |otherWebsiteUpdates|
 
+    * Click on **Save** at the bottom of the page.
diff --git a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst
@@ -11,9 +11,9 @@ cycles of the METplus components included in a coordinated release.
   * Navigate to the
     `Release Acceptance Testing <https://github.com/dtcenter/METplus/discussions/categories/release-acceptance-testing>`_
     discussion for this coordinated release.
-  * Review and finalize any entries still marked as **OPEN** or **FAIL** in the **Status**
-    column of the repository testing tables. Ideally, the status for all table entries
-    should be **PASS** for a coordinated release.
+  * Review the repository testing tables for the METplus components within the body of the discussion.
+  * Check the **Status** column in these tables and look for entries still marked as **OPEN** or **FAIL**.
+    For a coordinated release, the status for all table entries should be **PASS**.
   * Click on the **Close discussion** button at the bottom discussion.
   * Do *not* **Lock conversation** on this discussion to allow external testers
     to provide additional comments, as needed.
diff --git a/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst b/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst
@@ -1,66 +1,71 @@
 Update DTC Website
 ------------------
 
-* Navigate to https://dtcenter.org and sign in to the Drupal interface.
+METplus software releases are announced on the `DTC website <https://dtcenter.org>`_.
+Add or update information about software releases on the website.
 
-* Navigate to the METplus downloads page at
-  https://dtcenter.org/community-code/metplus/download
+.. dropdown:: Instructions
 
-* Click on the **Edit** button to edit the Downloads page.
+  * Navigate to https://dtcenter.org and sign in to the Drupal interface.
 
-* Create a new **Software Release** for the new coordinated release by clicking
-  on **Add New Release**.
+  * Navigate to the METplus downloads page at
+    https://dtcenter.org/community-code/metplus/download
 
-  * For **Full Title of Release** type "Coorindated METplus X.Y".
+  * Click on the **Edit** button to edit the Downloads page.
 
-  * For **Related Community Code** select only the "METplus" option.
+  * Create a new **Software Release** for the new coordinated release by clicking
+    on **Add New Release**.
 
-  * For **Version Label** type "Coordinated METplus X.Y".
+    * For **Full Title of Release** type "Coorindated METplus X.Y".
 
-  * Select the **Release Type** as "Recommended".
+    * For **Related Community Code** select only the "METplus" option.
 
-  * Select the **Release Options** as "Coordinated".
+    * For **Version Label** type "Coordinated METplus X.Y".
 
-  * Enter the **Release Date**.
+    * Select the **Release Type** as "Recommended".
 
-  * Click on **Add Code Download** then click **Add Link** to add links for each of the following:
+    * Select the **Release Options** as "Coordinated".
 
-    * Add Link: Link text should be "METplus X.Y.Z" and the URL should be a link to the METplus component DTC release page.
+    * Enter the **Release Date**.
 
-    * Add Link: Link text should be "MET X.Y.Z" and the URL should be a link to the MET component DTC release page.
+    * Click on **Add Code Download** then click **Add Link** to add links for each of the following:
 
-    * Add Link: Link text should be "METviewer X.Y.Z" and the URL should be a link to the METviewer component DTC release page.
+      * Add Link: Link text should be "METplus X.Y.Z" and the URL should be a link to the METplus component DTC release page.
 
-    * Add Link: Link text should be "METexpress X.Y.Z" and the URL should be a link to the METexpress component DTC release page.
+      * Add Link: Link text should be "MET X.Y.Z" and the URL should be a link to the MET component DTC release page.
 
-    * Add Link: Link text should be "METplotpy X.Y.Z" and the URL should be a link to the METplotpy component DTC release page.
+      * Add Link: Link text should be "METviewer X.Y.Z" and the URL should be a link to the METviewer component DTC release page.
 
-    * Add Link: Link text should be "METcalcpy X.Y.Z" and the URL should be a link to the METcalcpy component DTC release page.
+      * Add Link: Link text should be "METexpress X.Y.Z" and the URL should be a link to the METexpress component DTC release page.
 
-    * Add Link: Link text should be "METdataio X.Y.Z" and the URL should be a link to the METdataio component DTC release page.
+      * Add Link: Link text should be "METplotpy X.Y.Z" and the URL should be a link to the METplotpy component DTC release page.
 
-    * Add Link: Link text should be "Documentation" and the URL should be the top
-      level directory of the main_vX.Y branch of the METplus User's Guide hosted on the web.
-      For example, use
-      "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT
-      "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/"
+      * Add Link: Link text should be "METcalcpy X.Y.Z" and the URL should be a link to the METcalcpy component DTC release page.
 
-    * Add Link: Link text should be "Existing Builds and Docker" and the URL
-      should be the latest Existing Builds page, i.e.
-      https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds
+      * Add Link: Link text should be "METdataio X.Y.Z" and the URL should be a link to the METdataio component DTC release page.
 
-  * In the **Release Notes** text box provide direct links to the *release-notes.html*
-    files on the main_vX.Y branch of the User's Guide for each component.
+      * Add Link: Link text should be "Documentation" and the URL should be the top
+        level directory of the main_vX.Y branch of the METplus User's Guide hosted on the web.
+        For example, use
+        "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT
+        "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/"
 
-  * Click on **Create Release**.
+      * Add Link: Link text should be "Existing Builds and Docker" and the URL
+        should be the latest Existing Builds page, i.e.
+        https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds
 
-  * Update any existing coordinated releases by changing the **Release Type** from
-    "Recommended" to "Other" and click the **Update Release** button.
+    * In the **Release Notes** text box provide direct links to the *release-notes.html*
+      files on the main_vX.Y branch of the User's Guide for each component.
 
-  * Review the existing component releases and remove any remaining development
-    releases (e.g. beta and rc) for any of the official releases included in this
-    coordinated release.
+    * Click on **Create Release**.
 
-  * Click on **Save** at the bottom of the page.
+    * Update any existing coordinated releases by changing the **Release Type** from
+      "Recommended" to "Other" and click the **Update Release** button.
 
-* Create a new **Existing Builds and Docker** page for the next coordinated release.
+    * Review the existing component releases and remove any remaining development
+      releases (e.g. beta and rc) for any of the official releases included in this
+      coordinated release.
+
+    * Click on **Save** at the bottom of the page.
+
+  * Create a new **Existing Builds and Docker** page for the next coordinated release.