Feature 1847 release (#1850)

* Per #1847, moved release notes to be its own chapter, reformatted component release notes, and added new section for upgrade instructions * Per #1847, added release-notes internal tag * Per #1847, fix error and reformat link * Per #1847, modified release instructions to add a section about upgrade instructions * Per #1847, modified release instructions to add a section about upgrade instructions * Per #1847, resolve doc warnings * Per #1847, updated instructions for clarity. * Per #1847, modified text and link. * Per #1847, modified wording and resolve error with note
dtcenter · Oct 5, 2022 · d7c117f · d7c117f
1 parent 40e05c0
commit d7c117f
Show file tree

Hide file tree

Showing 16 changed files with 69 additions and 36 deletions.
diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/met/update_version_development.rst
 .. include:: release_steps/update_release_notes_development.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst

diff --git a/docs/Release_Guide/met_official.rst b/docs/Release_Guide/met_official.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/met/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/met/create_release_reference_branch.rst

diff --git a/docs/Release_Guide/metcalcpy_development.rst b/docs/Release_Guide/metcalcpy_development.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metcalcpy/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst

diff --git a/docs/Release_Guide/metcalcpy_official.rst b/docs/Release_Guide/metcalcpy_official.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metcalcpy/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst

diff --git a/docs/Release_Guide/metdataio_development.rst b/docs/Release_Guide/metdataio_development.rst
@@ -14,6 +14,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metdataio/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst

diff --git a/docs/Release_Guide/metdataio_official.rst b/docs/Release_Guide/metdataio_official.rst
@@ -14,6 +14,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metdataio/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst

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

diff --git a/docs/Release_Guide/metplotpy_official.rst b/docs/Release_Guide/metplotpy_official.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metplotpy/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst

diff --git a/docs/Release_Guide/metplus_development.rst b/docs/Release_Guide/metplus_development.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metplus/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/metplus/create_release_extra.rst

diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metplus/update_release_date.rst
 .. include:: release_steps/update_release_notes_official.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/metplus/update_manage_externals.rst
 .. include:: release_steps/merge_release_issue.rst

diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metviewer/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst

diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst
@@ -11,6 +11,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metviewer/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
+.. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/create_release_branch.rst

diff --git a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst
@@ -0,0 +1,26 @@
+Update Upgrade Instructions
+---------------------------
+
+Occasionally, changes will be made to software that will require users to make
+changes to their configuration files in order to use the latest release. For
+example, when ensemble post-processing was added to Gen-Ens-Prod and removed
+from Ensemble-Stat, users were required to make changes in their configuration
+files.
+
+.. note::
+
+  This section is not always applicable.
+
+
+To alert the users to the necessary steps involved with the upgrade:
+
+* Update the Upgrade Instructions section of the release-notes.rst file found
+  in the |projectRepo| User's Guide directory with the necessary information.
+
+* Add an "upgrade instructions" link next to the appropriate METplus component
+  (|projectRepo|) after "latest" and before "development" in
+  the :ref:`METplus Components Release Note Links <components-release-notes>`
+  section in the release-notes.rst file in the METplus User's Guide in the
+  `METplus GitHub repository <https://github.com/dtcenter/METplus>`__ ONLY
+  if there are Upgrade Instructions for this release.
+
diff --git a/docs/Users_Guide/index.rst b/docs/Users_Guide/index.rst
@@ -78,6 +78,7 @@ is sponsored by NSF.
    :numbered: 4
 
    overview
+   release-notes
    getting_started
    installation
    systemconfiguration

diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst
@@ -689,10 +689,6 @@ METplus Components Python Requirements
     - 
 
 
-.. _release-notes:
-
-.. include:: release-notes.rst
-
 Future development plans
 ========================
 

diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst
@@ -1,46 +1,37 @@
-METplus Release Notes
-=====================
+***************************
+METplus Release Information
+***************************
+
+.. _release-notes:
 
 Users can view the :ref:`releaseCycleStages` section of
 the Release Guide for descriptions of the development releases (including
 beta releases and release candidates), official releases, and bugfix
 releases for the METplus Components.
 
+.. _components-release-notes:
+
 METplus Components Release Note Links
--------------------------------------
-
-Release Notes - Latest Official Release
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* `MET <https://met.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__
-* `METviewer <https://metviewer.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__
-* `METplotpy <https://metplotpy.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__
-* `METcalcpy <https://metcalcpy.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__
-* `METdatadb <https://metdatadb.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__
-* `METexpress <https://github.com/dtcenter/METexpress/releases>`__
-* `METplus Wrappers <https://metplus.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__
-
-Release Notes - Development Release
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* `MET <https://met.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__
-* `METviewer <https://metviewer.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__
-* `METplotpy <https://metplotpy.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__
-* `METcalcpy <https://metcalcpy.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__
-* `METdatadb <https://metdatadb.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__
-* `METexpress <https://github.com/dtcenter/METexpress/releases>`__
-* `METplus Wrappers <https://metplus.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__
+=====================================
+
+* MET (`latest <https://met.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__, `development <https://met.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__)
+* METviewer (`latest <https://metviewer.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__, `development <https://metviewer.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__)
+* METplotpy (`latest <https://metplotpy.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__, `development <https://metplotpy.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__)
+* METcalcpy (`latest <https://metcalcpy.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__, `development <https://metcalcpy.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__)
+* METdataio (`latest <https://metdataio.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__, `development <https://metdataio.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__)
+* METexpress (`latest <https://github.com/dtcenter/METexpress/releases>`__, `development <https://github.com/dtcenter/METexpress/releases>`__)
+* METplus Wrappers (`latest <https://metplus.readthedocs.io/en/latest/Users_Guide/release-notes.html>`__, :ref:`upgrade instructions <upgrade-instructions>`, `development <https://metplus.readthedocs.io/en/develop/Users_Guide/release-notes.html>`__)
+
 
 METplus Wrappers Release Notes
-------------------------------
+==============================
 
-When applicable, release notes are followed by the GitHub issue number which
-describes the bugfix, enhancement, or new feature:
-https://github.com/dtcenter/METplus/issues
+When applicable, release notes are followed by the `GitHub issue <https://github.com/dtcenter/METplus/issues>`__ number which
+describes the bugfix, enhancement, or new feature.
 
 
 METplus Version 5.0.0 Beta 3 Release Notes (2022-09-21)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------------------------------
 
 .. warning:: **MAJOR CHANGES**:
 
@@ -87,7 +78,7 @@ METplus Version 5.0.0 Beta 3 Release Notes (2022-09-21)
 
 
 METplus Version 5.0.0 Beta 2 Release Notes (2022-08-03)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------------------------------
 
 * Enhancements:
 
@@ -103,7 +94,7 @@ METplus Version 5.0.0 Beta 2 Release Notes (2022-08-03)
 
 
 METplus Version 5.0.0 Beta 1 Release Notes (2022-06-22)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------------------------------
 
 * Enhancements:
 
@@ -136,3 +127,10 @@ METplus Version 5.0.0 Beta 1 Release Notes (2022-06-22)
   * Document GitHub Discussions procedure for the Contributor's Guide (`#1159 <https://github.com/dtcenter/METplus/issues/1159>`_)
   * Create a METplus "Release Guide" describing how to build releases for the METplus components (`#673 <https://github.com/dtcenter/METplus/issues/673>`_)
   * Update documentation about viewing RTD URLs on branches (`#1512 <https://github.com/dtcenter/METplus/issues/1512>`_)
+
+.. _upgrade-instructions:
+
+METplus Wrappers Upgrade Instructions
+=====================================
+
+Coming Soon!