From 52d07c0c7e3dad06c051543ba4c7ed32bb512397 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 14:51:19 -0600 Subject: [PATCH 1/9] 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 e08f2ea38..e5afd2f3d 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 02dc58182..a6b61780e 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 d1ee02655..d17891288 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! From 56a3ad39748e9c1e2f2ea78a477e3bd9b658cd5b Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 14:53:24 -0600 Subject: [PATCH 2/9] Per #1847, added release-notes internal tag --- docs/Users_Guide/release-notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index d17891288..1b9197f90 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -2,6 +2,7 @@ METplus Release Information *************************** +.. _release-notes: Users can view the :ref:`releaseCycleStages` section of the Release Guide for descriptions of the development releases (including From f2eef5417cdfb87ef2740372b7ea0d571ede9c6b Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 15:06:44 -0600 Subject: [PATCH 3/9] Per #1847, fix error and reformat link --- docs/Users_Guide/release-notes.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index 1b9197f90..04f6d0417 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -18,15 +18,14 @@ METplus Components Release Note Links * METcalcpy (`latest `__, `development `__) * METdataio (`latest `__, `development `__) * METexpress (`latest `__, `development `__) -* METplus Wrappers (`latest `__, :ref:`upgrade instructions `__, `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) From bb0933c56b751a4851fc0c5c9bfbce703bf6692d Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 16:15:21 -0600 Subject: [PATCH 4/9] Per #1847, modified release instructions to add a section about upgrade instructions --- docs/Release_Guide/met_development.rst | 1 + docs/Release_Guide/met_official.rst | 1 + docs/Release_Guide/metcalcpy_development.rst | 1 + docs/Release_Guide/metcalcpy_official.rst | 1 + docs/Release_Guide/metdataio_development.rst | 1 + docs/Release_Guide/metdataio_official.rst | 1 + docs/Release_Guide/metplotpy_development.rst | 1 + docs/Release_Guide/metplotpy_official.rst | 1 + docs/Release_Guide/metplus_development.rst | 1 + docs/Release_Guide/metplus_official.rst | 1 + docs/Release_Guide/metviewer_development.rst | 1 + docs/Release_Guide/metviewer_official.rst | 1 + .../update_upgrade_instructions.rst | 21 +++++++++++++++++++ 13 files changed, 33 insertions(+) create mode 100644 docs/Release_Guide/release_steps/update_upgrade_instructions.rst diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst index a37f672b5..3690a9468 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 98bcc841f..81e8269ab 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 a9a74901f..936a9c9ce 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 4a6638018..f5b5ef3d4 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 a3a66e292..810725ccf 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 c20542c5c..d0b54155f 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 7913284c0..3e78b5c84 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 20ac22ca6..2f6a68f1f 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 2bd584343..6dd1b4b1f 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 47a1ba344..f2a9acb2d 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 4a11effc2..6b2cea9e8 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 bd5f4c272..624195d6d 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 000000000..34b4b3ef5 --- /dev/null +++ b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst @@ -0,0 +1,21 @@ +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 config files. + +To alert the users to the necessary steps involved in 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 a section next to the appropriate METplus component (|projectRepo|) under + the :ref:`` 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. + +.. _note:: +This section is not always applicable. From 4ff062cde3b23e94a4d63ba240401f7699b1a652 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 17:23:36 -0600 Subject: [PATCH 5/9] Per #1847, modified release instructions to add a section about upgrade instructions --- docs/Users_Guide/release-notes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index 04f6d0417..d85d9fef8 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -9,6 +9,8 @@ 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 ===================================== From c9b0269f4ce206a87645094cd4e2f598cc4ff4c9 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 17:40:45 -0600 Subject: [PATCH 6/9] Per #1847, resolve doc warnings --- .../release_steps/update_upgrade_instructions.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst index 34b4b3ef5..717d82aff 100644 --- a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst +++ b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst @@ -12,10 +12,11 @@ To alert the users to the necessary steps involved in the upgrade: in the |projectRepo| User's Guide directory with the necessary information. * Add a section next to the appropriate METplus component (|projectRepo|) under - the :ref:`` section in the release-notes.rst file - in the METplus User's Guide in the + 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. .. _note:: -This section is not always applicable. + + This section is not always applicable. From 0437c47732f7f7a5b6c9d9e2f927caa508e43660 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 4 Oct 2022 17:50:16 -0600 Subject: [PATCH 7/9] Per #1847, updated instructions for clarity. --- .../release_steps/update_upgrade_instructions.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst index 717d82aff..9bcf56c5c 100644 --- a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst +++ b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst @@ -11,7 +11,8 @@ To alert the users to the necessary steps involved in 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 a section next to the appropriate METplus component (|projectRepo|) under +* 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 From 32c3af420f04e18dad1af7fc65c110f2bf2b715d Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Wed, 5 Oct 2022 11:16:28 -0600 Subject: [PATCH 8/9] Per #1847, modified text and link. --- .../release_steps/update_upgrade_instructions.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst index 9bcf56c5c..d3f4d11b6 100644 --- a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst +++ b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst @@ -4,7 +4,8 @@ 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 config files. +from Ensemble-Stat, users were required to make changes in their configuration +files. To alert the users to the necessary steps involved in the upgrade: @@ -13,7 +14,7 @@ To alert the users to the necessary steps involved in the upgrade: * 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 ` + the :ref:`components-release-notes` 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. From 7a19f9437c16ee071e002e765e6cfe9282fcc0b9 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Wed, 5 Oct 2022 11:22:15 -0600 Subject: [PATCH 9/9] Per #1847, modified wording and resolve error with note --- .../release_steps/update_upgrade_instructions.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst index d3f4d11b6..bb28f258b 100644 --- a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst +++ b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst @@ -7,18 +7,20 @@ 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. -To alert the users to the necessary steps involved in the upgrade: +.. 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:`components-release-notes` + 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. -.. _note:: - - This section is not always applicable.