Feature #2844 release_guide_dropdowns (#2847)

* Work in progress adding instructions dropdowns to the release guide * Per #2844, more dropdowns * Per #2844, add instruction dropdowns for all MET instructions * Per #2844, more dropdowns. * Per #2844, use instruction dropdowns throughout * Per #2844, remove METexpress AWS instruction since its no longer relevant. * Remove accidentally committed .DS_Store file.
dtcenter · Dec 20, 2024 · ea4c625 · ea4c625
1 parent 84b32cf
commit ea4c625
Show file tree

Hide file tree

Showing 86 changed files with 913 additions and 757 deletions.
diff --git a/docs/Release_Guide/met_bugfix.rst b/docs/Release_Guide/met_bugfix.rst
@@ -13,7 +13,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/update_release_notes_bugfix.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/met/update_dtc_website.rst
 .. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_bugfix.rst
diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst
@@ -17,7 +17,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/met/create_release_reference_branch.rst
 .. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/met/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_development.rst
 .. include:: release_steps/release_acceptance_testing.rst
diff --git a/docs/Release_Guide/met_official.rst b/docs/Release_Guide/met_official.rst
@@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/met/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
 .. include:: release_steps/met/update_tar_files_link_official.rst

diff --git a/docs/Release_Guide/metcalcpy_bugfix.rst b/docs/Release_Guide/metcalcpy_bugfix.rst
@@ -13,7 +13,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/update_release_notes_bugfix.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
diff --git a/docs/Release_Guide/metcalcpy_development.rst b/docs/Release_Guide/metcalcpy_development.rst
@@ -15,7 +15,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_development.rst
 .. include:: release_steps/release_acceptance_testing.rst

diff --git a/docs/Release_Guide/metcalcpy_official.rst b/docs/Release_Guide/metcalcpy_official.rst
@@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
 .. include:: release_steps/metcalcpy/update_version_on_develop.rst

diff --git a/docs/Release_Guide/metdataio_bugfix.rst b/docs/Release_Guide/metdataio_bugfix.rst
@@ -16,7 +16,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/update_release_notes_bugfix.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/common/update_dtc_website.rst
 .. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_bugfix.rst
diff --git a/docs/Release_Guide/metdataio_development.rst b/docs/Release_Guide/metdataio_development.rst
@@ -5,7 +5,7 @@ METdataio Development Release
 .. |projectName| replace:: |projectRepo|
 .. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab.
 .. |otherWebsiteUpdates| replace:: Make any other necessary website updates.
-			      
+
 Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop branch while working toward an official vX.Y.Z release.
 
 .. include:: release_steps/open_release_issue.rst
@@ -18,7 +18,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/common/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_development.rst
 .. include:: release_steps/release_acceptance_testing.rst

diff --git a/docs/Release_Guide/metdataio_official.rst b/docs/Release_Guide/metdataio_official.rst
@@ -5,7 +5,7 @@ METdataio Official Release
 .. |projectName| replace:: |projectRepo|
 .. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab.
 .. |otherWebsiteUpdates| replace:: Make any other necessary website updates.
-			      
+
 Create a new vX.Y.Z official release from the develop branch.
 
 .. include:: release_steps/open_release_issue.rst
@@ -18,7 +18,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/common/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
 .. include:: release_steps/metdataio/update_version_on_develop.rst

diff --git a/docs/Release_Guide/metexpress_official.rst b/docs/Release_Guide/metexpress_official.rst
@@ -14,7 +14,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/metexpress/tag_app_version_and_build.rst
 .. include:: release_steps/metexpress/deploy_beta_apps.rst
 .. include:: release_steps/metexpress/deploy_production_apps.rst
-.. include:: release_steps/metexpress/deploy_AWS_apps.rst
 .. include:: release_steps/metexpress/pull_changes_and_merge_to_dev.rst
 .. include:: release_steps/update_docs_official.rst
 .. include:: release_steps/metexpress/update_dtc_website.rst

diff --git a/docs/Release_Guide/metplotpy_bugfix.rst b/docs/Release_Guide/metplotpy_bugfix.rst
@@ -12,7 +12,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/update_release_notes_bugfix.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst

diff --git a/docs/Release_Guide/metplotpy_development.rst b/docs/Release_Guide/metplotpy_development.rst
@@ -15,7 +15,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_development.rst
 .. include:: release_steps/release_acceptance_testing.rst

diff --git a/docs/Release_Guide/metplotpy_official.rst b/docs/Release_Guide/metplotpy_official.rst
@@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
 .. include:: release_steps/metplotpy/update_version_official.rst

diff --git a/docs/Release_Guide/metplus_bugfix.rst b/docs/Release_Guide/metplus_bugfix.rst
@@ -13,8 +13,7 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/update_release_notes_bugfix.rst
 .. include:: release_steps/metplus/update_existing_builds_docker.rst
 .. include:: release_steps/merge_release_issue.rst
-.. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/metplus/create_release_extra.rst
+.. include:: release_steps/metplus/create_release_on_github.rst
 .. include:: release_steps/metplus/update_dtc_website.rst
 .. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
diff --git a/docs/Release_Guide/metplus_development.rst b/docs/Release_Guide/metplus_development.rst
@@ -16,8 +16,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/metplus/update_existing_builds_docker.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/metplus/create_release_reference_branch.rst
-.. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/metplus/create_release_extra.rst
+.. include:: release_steps/metplus/create_release_on_github.rst
 .. include:: release_steps/metplus/update_version_on_develop.rst
 .. include:: release_steps/metplus/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_development.rst

diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst
@@ -4,7 +4,7 @@ METplus Official Release
 .. |projectRepo| replace:: METplus
 
 Create a new vX.Y.Z official release from the develop branch.
-			   
+
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
 .. include:: release_steps/checkout_main_branch.rst
@@ -17,8 +17,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/metplus/update_existing_builds_docker.rst
 .. include:: release_steps/merge_release_issue.rst
-.. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/metplus/create_release_extra.rst
+.. include:: release_steps/metplus/create_release_on_github.rst
 .. include:: release_steps/metplus/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
 .. include:: release_steps/update_docs_official.rst

diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst
@@ -5,15 +5,14 @@ METviewer Bugfix Release
 
 Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 
-.. include:: release_steps/open_release_issue.rst	     
+.. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
 .. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metviewer/update_version_bugfix.rst
 .. include:: release_steps/update_release_notes_bugfix.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst
@@ -15,7 +15,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_development.rst
 .. include:: release_steps/release_acceptance_testing.rst

diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst
@@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
-.. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
 .. include:: release_steps/metviewer/update_version_on_develop.rst

diff --git a/docs/Release_Guide/release_steps/checkout_main_branch.rst b/docs/Release_Guide/release_steps/checkout_main_branch.rst
@@ -1,9 +1,11 @@
 Checkout the Main Branch
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-Checkout the main branch for the X.Y release. If you are creating
-the |projectRepo|-X.Y.Z official or bugfix release, checkout main_vX.Y.
+.. dropdown:: Instructions
 
-.. parsed-literal::
+  Checkout the main branch for the X.Y release. If you are creating
+  the |projectRepo|-X.Y.Z official or bugfix release, checkout main_vX.Y.
 
-    git checkout main_vX.Y
+  .. parsed-literal::
+
+      git checkout main_vX.Y
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/clone_project_repository.rst b/docs/Release_Guide/release_steps/clone_project_repository.rst
@@ -1,30 +1,34 @@
 Clone the Project Repository
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Create and work in a new directory to ensure a fresh environment:
+Clone the repository onto your local machine.
 
-.. parsed-literal::
+.. dropdown:: Instructions
 
-    mkdir release-X.Y.Z
-    cd release-X.Y.Z
+  * Create and work in a new directory to ensure a fresh environment:
 
-* Run the clone command to obtain the repository.
+  .. parsed-literal::
 
-Using SSH:
+      mkdir release-X.Y.Z
+      cd release-X.Y.Z
 
-.. parsed-literal::
+  * Run the clone command to obtain the repository.
 
-    git clone [email protected]:dtcenter/|projectRepo|
+  Using SSH:
 
-Using HTTP:
+  .. parsed-literal::
 
-.. parsed-literal::
+      git clone [email protected]:dtcenter/|projectRepo|
 
-    git clone https://github.com/dtcenter/|projectRepo|
+  Using HTTP:
 
-* Enter the project repository directory:
+  .. parsed-literal::
 
-.. parsed-literal::
+      git clone https://github.com/dtcenter/|projectRepo|
 
-    cd |projectRepo|
+  * Enter the project repository directory:
+
+  .. parsed-literal::
+
+      cd |projectRepo|
 
diff --git a/docs/Release_Guide/release_steps/coordinated/announce_release.rst b/docs/Release_Guide/release_steps/coordinated/announce_release.rst
@@ -1,6 +1,10 @@
 Announce Release
 ----------------
 
-* Contact the METplus project manager to announce the coordinated release via email.
+Let users know about this new coordinated release.
 
-* Contact the RAL-IT group to request that the coordinated release components be installed in */usr/local* to be used on all RAL machines.
+.. dropdown:: Instructions
+
+  * Contact the METplus project manager to announce the coordinated release via email.
+
+  * Contact the RAL-IT group to request that the coordinated release components be installed in */usr/local* to be used on all RAL machines.
diff --git a/docs/Release_Guide/release_steps/coordinated/update_zenodo.rst b/docs/Release_Guide/release_steps/coordinated/update_zenodo.rst
@@ -1,9 +1,13 @@
 Update Zenodo
 -------------
 
-In the `METplus GitHub repository <https://github.com/dtcenter/METplus>`_
-scroll down to the README file and check the
-`METplus Coordinated Release Digital Object Identifier (DOI) <https://doi.org/10.5281/zenodo.5567804>`_
-on Zenodo. Once all METplus components have been released, gather the zip files
-for each METplus component release in the METplus Verification System
-Coordinated Release and upload them to create a new version on Zenodo.
+Update the DOI for this coordinated release.
+
+.. dropdown:: Instructions
+
+  In the `METplus GitHub repository <https://github.com/dtcenter/METplus>`_
+  scroll down to the README file and check the
+  `METplus Coordinated Release Digital Object Identifier (DOI) <https://doi.org/10.5281/zenodo.5567804>`_
+  on Zenodo. Once all METplus components have been released, gather the zip files
+  for each METplus component release in the METplus Verification System
+  Coordinated Release and upload them to create a new version on Zenodo.
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,22 @@
 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::
 
-.. parsed-literal::
+      cd |projectRepo|
+      git checkout develop
+      git pull
+      git checkout -b main_vX.Y
+      git push -u origin main_vX.Y
 
-    cd |projectRepo|
-    git checkout develop
-    git pull
-    git checkout -b main_vX.Y
-    git push -u origin main_vX.Y
+.. dropdown:: If creating a betaN or rc2+ release
 
+  Continue to the next instruction.
diff --git a/docs/Release_Guide/release_steps/create_release_extra.rst b/docs/Release_Guide/release_steps/create_release_extra.rst
diff --git a/docs/Release_Guide/release_steps/create_release_feature_branch.rst b/docs/Release_Guide/release_steps/create_release_feature_branch.rst
@@ -1,10 +1,14 @@
 Create Release Feature Branch
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Create a feature branch in which to update the version number and add release notes being sure to include the GitHub issue number for the new release.
+Create a feature branch to update the version number and add release notes.
 
-.. parsed-literal::
+.. dropdown:: Instructions
 
-    git checkout -b feature_NNNN_vX.Y.Z       # for an official or bugfix release
-    git checkout -b feature_NNNN_vX.Y.Z-betaN # for a development release
-    git checkout -b feature_NNNN_vX.Y.Z-rcN   # for a development release
+  * Include the GitHub issue number in the feature branch for the new release.
+
+  .. parsed-literal::
+
+      git checkout -b feature_NNNN_vX.Y.Z       # for an official or bugfix release
+      git checkout -b feature_NNNN_vX.Y.Z-betaN # for a development release
+      git checkout -b feature_NNNN_vX.Y.Z-rcN   # for a development release