Per #2844, add instruction dropdowns for all MET instructions

dtcenter · Dec 19, 2024 · 1e8a0c9 · 1e8a0c9
1 parent eaac337
commit 1e8a0c9
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 83 deletions.
diff --git a/docs/Release_Guide/release_steps/checkout_source_branch.rst b/docs/Release_Guide/release_steps/checkout_source_branch.rst
@@ -1,18 +1,22 @@
 Checkout the Source Branch
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* If creating a **beta** (betaN) or **first release candidate** (rc1) release,
-  checkout the develop branch:
+Checkout the source branch based on the type of release to be created.
 
-.. parsed-literal::
+.. dropdown:: If creating a beta or rc1 release
 
-    git checkout develop
+  * If creating a **beta** (betaN) or **first release candidate** (rc1) release,
+    checkout the develop branch:
 
-**OR**
+  .. parsed-literal::
 
-* If creating a **later release candidate** (rc2+) release,
-  checkout the appropriate main branch:
+      git checkout develop
 
-.. parsed-literal::
+.. dropdown:: If creating an rc2+ release
 
-    git checkout main_vX.Y
+  * If creating a **later release candidate** (rc2+) release,
+    checkout the appropriate main branch:
+
+  .. parsed-literal::
+
+      git checkout main_vX.Y
diff --git a/docs/Release_Guide/release_steps/create_release_branch.rst b/docs/Release_Guide/release_steps/create_release_branch.rst
@@ -1,22 +1,18 @@
 Create Release Branch
 ^^^^^^^^^^^^^^^^^^^^^
 
-.. note::
+For rc1 development releases, create a new main branch for the upcoming official release.
 
-  These instructions only apply when creating the **first release candidate**
-  (rc1) development release. Skip this section for earlier beta (betaN) or later 
-  release candidate (rc2+) development releases.
+.. dropdown:: If creating an rc1 release
 
+  * Create a new 'main_vX.Y' branch from the develop branch for the upcoming
+    official release and push it to GitHub. All remaining development for the
+    upcoming official release occurs on this new 'main_vX.Y' branch.
 
-* Create a new 'main_vX.Y' branch from the develop branch for the upcoming
-  official release and push it to GitHub. All remaining development for the
-  upcoming official release occurs on this new 'main_vX.Y' branch.
-
-.. parsed-literal::
-
-    cd |projectRepo|
-    git checkout develop
-    git pull
-    git checkout -b main_vX.Y
-    git push -u origin main_vX.Y
+  .. parsed-literal::
 
+      cd |projectRepo|
+      git checkout develop
+      git pull
+      git checkout -b main_vX.Y
+      git push -u origin main_vX.Y
diff --git a/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst b/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst
@@ -1,44 +1,41 @@
 Create Release Reference Branch
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. note::
-
-  These instructions only apply when creating the **first release candidate**
-  (rc1) development release. Skip this section for earlier beta (betaN) or later 
-  release candidate (rc2+) development releases.
+For rc1 development releases, create a new reference branch for the upcoming official release.
 
+.. dropdown:: If creating an rc1 release
 
-* Create a branch from the develop branch for the reference branch for the
-  new official release and push it to GitHub. The branch name should match
-  the format 'main_vX.Y-ref' where X.Y is the major/minor release number.
+  * Create a branch from the develop branch for the reference branch for the
+    new official release and push it to GitHub. The branch name should match
+    the format 'main_vX.Y-ref' where X.Y is the major/minor release number.
 
-.. parsed-literal::
+  .. parsed-literal::
 
-    cd |projectRepo|
-    git checkout develop
-    git pull
-    git checkout -b main_vX.Y-ref
+      cd |projectRepo|
+      git checkout develop
+      git pull
+      git checkout -b main_vX.Y-ref
 
-Push Reference Branch to GitHub
-"""""""""""""""""""""""""""""""
+  * Push Reference Branch to GitHub
 
-::
+  .. parsed-literal::
 
-    git push -u origin main_vX.Y-ref
+      git push -u origin main_vX.Y-ref
 
-Pushing this branch to GitHub may trigger the GitHub Actions testing workflow
-to run all of the use cases and create a Docker data volumes with the output
-data. These data will be used to verify that any bugfixes applied to the
-'main_vX.Y' branch does not break any of existing logic. If the workflow was
-not automatically triggered, use the GitHub workflow dispatch option to manually
-run the **Testing** workflow for the 'main_vX.Y-ref' branch.
+    * Pushing this branch to GitHub may trigger the GitHub Actions testing workflow
+      to run all of the use cases and create a Docker data volumes with the output
+      data. These data will be used to verify that any bugfixes applied to the
+      'main_vX.Y' branch does not break any of existing logic.
 
-Monitor GitHub Actions Workflow
-"""""""""""""""""""""""""""""""
+    * If the workflow was not automatically triggered, use the GitHub workflow
+      dispatch option to manually run the **Testing** workflow for the 'main_vX.Y-ref'
+      branch.
 
-Navigate to https://github.com/dtcenter/MET/actions and verify that a
-'Testing' workflow was triggered on the 'main_vX.Y-ref' branch.
+  * Monitor GitHub Actions Workflow
 
-* Wait until the entire workflow has run successfully. The final job entitled
-  'Create Output Docker Data Volumes' should create Docker data volumes for
-  each use case category on DockerHub (dtcenter/met-dev).
+    * Navigate to https://github.com/dtcenter/MET/actions and verify that a
+      'Testing' workflow was triggered on the 'main_vX.Y-ref' branch.
+
+    * Wait until the entire workflow has run successfully. The final job entitled
+      'Create Output Docker Data Volumes' should create Docker data volumes for
+      each use case category on DockerHub (dtcenter/met-dev).
diff --git a/docs/Release_Guide/release_steps/met/update_tar_files_link_official.rst b/docs/Release_Guide/release_steps/met/update_tar_files_link_official.rst
@@ -1,8 +1,10 @@
 Update tar_files Link
 ^^^^^^^^^^^^^^^^^^^^^
 
-On the DTC web server machine (i.e. mohawk), in /d2/www/dtcenter/dfiles/code/METplus/MET/installation/, update
-the link for tar_files.latest.tgz, to point to the latest version of the
-tar_files.met-base-vX.Y.tgz file (viewable at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/installation/).
+Update the default input test data file.
 
+.. dropdown:: Instructions
 
+  On the DTC web server machine (i.e. mohawk), in /d2/www/dtcenter/dfiles/code/METplus/MET/installation/, update
+  the link for tar_files.latest.tgz, to point to the latest version of the
+  tar_files.met-base-vX.Y.tgz file (viewable at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/installation/).
diff --git a/docs/Release_Guide/release_steps/met/update_web_server_data.rst b/docs/Release_Guide/release_steps/met/update_web_server_data.rst
@@ -1,31 +1,24 @@
 Update DTC Web Server Data
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Create Directory for This Release
-"""""""""""""""""""""""""""""""""
+For rc1 development releases, create a new testing input data directory for the upcoming official release.
 
-.. note::
-
-  These instructions only apply when creating the **first release candidate**
-  (rc1) development release. Skip this section for earlier beta (betaN) or later 
-  release candidate (rc2+) development releases.
+.. dropdown:: If creating an rc1 release
 
+  On the DTC web server where the sample input data for unit tests is hosted,
+  create a new directory for this official major/minor release.
 
-On the DTC web server where the sample input data for unit tests is hosted,
-create a new directory for this official major/minor release.
+  The GitHub Actions automation creates version-specific input test data
+  volumes. It pulls input test data from the DTC web server, creates a Docker
+  data volume, and pushes the result to the dtcenter/met-data-dev DockerHub
+  repository.
 
-The GitHub Actions automation creates version-specific input test data
-volumes. It pulls input test data from the DTC web server, creates a Docker
-data volume, and pushes the result to the dtcenter/met-data-dev DockerHub
-repository.
+  * Log on to the DTC web server and run:
 
-Log on to the DTC web server and run:
+  ::
 
-::
-
-    runas met_test
-    cd /d2/www/dtcenter/dfiles/code/METplus/MET/MET_unit_test
-    cp -r develop vX.Y
-
-Confirm the result at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/MET_unit_test.
+      runas met_test
+      cd /d2/www/dtcenter/dfiles/code/METplus/MET/MET_unit_test
+      cp -r develop vX.Y
 
+  * Confirm the result at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/MET_unit_test.
diff --git a/docs/Release_Guide/release_steps/met/update_zenodo.rst b/docs/Release_Guide/release_steps/met/update_zenodo.rst
@@ -1,7 +1,11 @@
 Update Zenodo
 ^^^^^^^^^^^^^
 
-In the `MET GitHub repository <https://github.com/dtcenter/MET>`_
-scroll down to the README file and check the
-`MET Digital Object Identifier (DOI) <https://doi.org/10.5281/zenodo.5565322>`_
-on Zenodo. Use the zip file for the new MET release to create a new version on Zenodo.
+Update the DOI for this official release.
+
+.. dropdown:: Instructions
+
+  In the `MET GitHub repository <https://github.com/dtcenter/MET>`_
+  scroll down to the README file and check the
+  `MET Digital Object Identifier (DOI) <https://doi.org/10.5281/zenodo.5565322>`_
+  on Zenodo. Use the zip file for the new MET release to create a new version on Zenodo.
diff --git a/docs/Release_Guide/release_steps/update_docs_official.rst b/docs/Release_Guide/release_steps/update_docs_official.rst
@@ -3,7 +3,7 @@ Update the Documentation on the Web
 
 Update the default branch for Read the Docs.
 
-.. dropdown::Instructions
+.. dropdown:: Instructions
 
   Because Read the Docs is configured to automate the building of new "main"
   branches in the METplus components' repositories, nothing needs to be done