From 52d07c0c7e3dad06c051543ba4c7ed32bb512397 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 14:51:19 -0600 Subject: [PATCH] Per #1847, moved release notes to be its own chapter, reformatted component release notes, and added new section for upgrade instructions --- docs/Users_Guide/index.rst | 1 + docs/Users_Guide/overview.rst | 4 --- docs/Users_Guide/release-notes.rst | 54 ++++++++++++++---------------- 3 files changed, 26 insertions(+), 33 deletions(-) diff --git a/docs/Users_Guide/index.rst b/docs/Users_Guide/index.rst index e08f2ea38d..e5afd2f3df 100644 --- 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 index 02dc581823..a6b61780e4 100644 --- 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 index d1ee026553..d17891288c 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -1,5 +1,7 @@ -METplus Release Notes -===================== +*************************** +METplus Release Information +*************************** + Users can view the :ref:`releaseCycleStages` section of the Release Guide for descriptions of the development releases (including @@ -7,32 +9,19 @@ 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 `__ -* `METviewer `__ -* `METplotpy `__ -* `METcalcpy `__ -* `METdatadb `__ -* `METexpress `__ -* `METplus Wrappers `__ - -Release Notes - Development Release -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* `MET `__ -* `METviewer `__ -* `METplotpy `__ -* `METcalcpy `__ -* `METdatadb `__ -* `METexpress `__ -* `METplus Wrappers `__ +===================================== + +* MET (`latest `__, `development `__) +* METviewer (`latest `__, `development `__) +* METplotpy (`latest `__, `development `__) +* METcalcpy (`latest `__, `development `__) +* METdataio (`latest `__, `development `__) +* METexpress (`latest `__, `development `__) +* METplus Wrappers (`latest `__, :ref:`upgrade instructions `__, `development `__) + METplus Wrappers Release Notes ------------------------------- +============================== When applicable, release notes are followed by the GitHub issue number which describes the bugfix, enhancement, or new feature: @@ -40,7 +29,7 @@ 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 `_) * Create a METplus "Release Guide" describing how to build releases for the METplus components (`#673 `_) * Update documentation about viewing RTD URLs on branches (`#1512 `_) + +.. _upgrade-instructions: + +METplus Wrappers Upgrade Instructions +===================================== + +Coming Soon!