diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst index a37f672b5d..3690a94682 100644 --- 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 index 98bcc841fc..81e8269abf 100644 --- 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 index a9a74901f2..936a9c9ce7 100644 --- 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 index 4a66380180..f5b5ef3d40 100644 --- 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 index a3a66e2925..810725ccf6 100644 --- 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 index c20542c5c4..d0b54155f3 100644 --- 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 index 7913284c0f..3e78b5c84d 100644 --- 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 index 20ac22ca69..2f6a68f1f3 100644 --- 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 index 2bd5843439..6dd1b4b1f2 100644 --- 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 index 47a1ba344d..f2a9acb2d3 100644 --- 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 index 4a11effc2b..6b2cea9e8b 100644 --- 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 index bd5f4c2727..624195d6d1 100644 --- 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 new file mode 100644 index 0000000000..bb28f258b2 --- /dev/null +++ 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 ` + section in the release-notes.rst file in the METplus User's Guide in the + `METplus GitHub repository `__ ONLY + if there are Upgrade Instructions for this release. + 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..d85d9fef80 100644 --- 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 `__ -* `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: -https://github.com/dtcenter/METplus/issues +When applicable, release notes are followed by the `GitHub issue `__ 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 `_) * 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!