Per #1847, moved release notes to be its own chapter, reformatted com…

…ponent release notes, and added new section for upgrade instructions
dtcenter · Oct 4, 2022 · 52d07c0 · 52d07c0
1 parent 1bb2df4
commit 52d07c0
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 33 deletions.
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,35 @@
-METplus Release Notes
-=====================
+***************************
+METplus Release Information
+***************************
+
 
 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.
 
 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
 
 
 METplus Version 5.0.0 Beta 3 Release Notes (2022-09-21)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------------------------------
 
 .. warning:: **MAJOR CHANGES**:
 
@@ -87,7 +76,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 +92,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 +125,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!