From c3214d48b2326417d602528261f1a44b4dec6ba1 Mon Sep 17 00:00:00 2001 From: bikegeek Date: Tue, 9 Mar 2021 17:42:40 -0700 Subject: [PATCH 01/22] GitHub Issue #673 METviewer release guide "stubs". Details pertaining to METviewer will be added. Modelled after the METplotpy release process. --- docs/Release_Guide/metviewer_bugfix.rst | 11 +++++++++- docs/Release_Guide/metviewer_development.rst | 12 ++++++++++- docs/Release_Guide/metviewer_official.rst | 11 ++++++++++ .../metviewer/create_release_extra.rst | 3 +++ .../metviewer/update_docs_bugfix.rst | 11 ++++++++++ .../metviewer/update_docs_develop.rst | 11 ++++++++++ .../metviewer/update_docs_tagged.rst | 16 +++++++++++++++ .../metviewer/update_dtc_website.rst | 5 +++++ .../metviewer/update_version.rst | 8 ++++++++ .../metviewer/update_version_bugfix.rst | 9 +++++++++ .../metviewer/update_version_official.rst | 15 ++++++++++++++ .../metviewer/update_version_on_develop.rst | 20 +++++++++++++++++++ 12 files changed, 130 insertions(+), 2 deletions(-) create mode 100644 docs/Release_Guide/release_steps/metviewer/create_release_extra.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_version.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_version_official.rst create mode 100644 docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst index ea93ed811e..c060c6bf42 100644 --- a/docs/Release_Guide/metviewer_bugfix.rst +++ b/docs/Release_Guide/metviewer_bugfix.rst @@ -7,4 +7,13 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/open_release_issue.rst .. include:: release_steps/clone_project_repository.rst -.. include:: release_steps/checkout_develop_branch.rst +.. include:: release_steps/checkout_main_branch.rst +.. include:: release_steps/metviewer/update_version_bugfix.rst +.. include:: release_steps/update_release_notes_bugfix.rst +.. include:: release_steps/metviewer/update_docs_bugfix.rst +.. include:: release_steps/merge_release_issue.rst +.. include:: release_steps/create_release_on_github.rst +.. include:: release_steps/metviewer/create_release_extra.rst +.. include:: release_steps/metviewer/update_dtc_website.rst +.. include:: release_steps/finalize_release_on_github_official.rst + diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 468ca154c6..2830a8060d 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -7,5 +7,15 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/open_release_issue.rst .. include:: release_steps/clone_project_repository.rst -.. include:: release_steps/checkout_main_branch.rst +.. include:: release_steps/checkout_develop_branch.rst +.. include:: release_steps/metviewer/update_version.rst +.. include:: release_steps/update_release_notes_development.rst +.. include:: release_steps/metviewer/update_docs_develop.rst +.. include:: release_steps/merge_release_issue.rst +.. include:: release_steps/create_release_on_github.rst +.. include:: release_steps/metviewer/create_release_extra.rst +.. include:: release_steps/metviewer/update_dtc_website.rst +.. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/metviewer/update_version_on_develop.rst + diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index a9ee88ff3a..b0c9715ae3 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -8,5 +8,16 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/open_release_issue.rst .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_develop_branch.rst +.. include:: release_steps/metviewer/update_version_official.rst +.. include:: release_steps/update_release_notes_official.rst +.. include:: release_steps/metviewer/update_docs_tagged.rst +.. include:: release_steps/merge_release_issue.rst +.. include:: release_steps/create_release_branch.rst +.. include:: release_steps/push_release_branch.rst +.. include:: release_steps/create_release_on_github.rst +.. include:: release_steps/metviewer/create_release_extra.rst +.. include:: release_steps/update_dtc_website.rst +.. include:: release_steps/finalize_release_on_github_official.rst +.. include:: release_steps/metviewer/update_version_on_develop.rst diff --git a/docs/Release_Guide/release_steps/metviewer/create_release_extra.rst b/docs/Release_Guide/release_steps/metviewer/create_release_extra.rst new file mode 100644 index 0000000000..a5aea726b5 --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/create_release_extra.rst @@ -0,0 +1,3 @@ +* If this is a development release, check the box that says "This is a pre-release" + +* Click on "Publish release". diff --git a/docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst b/docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst new file mode 100644 index 0000000000..f48f7a43d3 --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst @@ -0,0 +1,11 @@ +Update the Documentation on the Web +----------------------------------- + +* Build the documentation with the correct conda environment by entering the + docs directory and running: `make clean;make html` + +* In another directory, checkout the gh-pages branch of repository. +* Put all contents of docs/_build/html into the directory for the major/minor release, + i.e. vX.Y.Z +* Commit changes and push to GitHub. +* Verify that documentation is updated on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst b/docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst new file mode 100644 index 0000000000..82c9e572f7 --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst @@ -0,0 +1,11 @@ +Update the Documentation on the Web +----------------------------------- + +* Refer to the Contributor's Guide for instructions on `how to build the + documentation `_. +* Build the documentation with the correct conda environment by entering the + docs directory and running `make clean;make html` +* In another directory, checkout the gh-pages branch of repository. +* On the gh-pages branch, remove all contents of develop directory. +* Put all contents of docs/_build/html into the develop directory. +* Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst b/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst new file mode 100644 index 0000000000..31ac770ceb --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst @@ -0,0 +1,16 @@ +Update the Documentation on the Web +----------------------------------- + +* Refer to the Contributor's Guide for instructions on `how to build the + documentation `_. +* Build the documentation with the correct conda environment by entering the + docs directory and running `make clean;make html` +* In another directory, checkout the gh-pages branch of repository. +* Create a new directory in the gh-pages branch for the release appending a + "v" to the front, i.e. vX.Y.Z +* Put all contents of docs/_build/html into the directory. +* Update versions.json to add the new directory name. +* Update symbolic link for 'latest' to point to new version. +* Commit changes and push to GitHub. +* Verify that documentation appears in the pull-down and latest points to the + new version on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst new file mode 100644 index 0000000000..8b5fb6554a --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst @@ -0,0 +1,5 @@ +.. include:: release_steps/common/update_dtc_website.rst + +.. |projectName| replace:: METplus Wrappers + +.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab. \ No newline at end of file diff --git a/docs/Release_Guide/release_steps/metviewer/update_version.rst b/docs/Release_Guide/release_steps/metviewer/update_version.rst new file mode 100644 index 0000000000..536a9bba15 --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_version.rst @@ -0,0 +1,8 @@ +Update Version Number for Release +--------------------------------- + +Create the version number + +- In the METplotpy/docs/version file, assign the version to the '__version__' keyword +- We are naming releases with X.Y.Z format even if Z is 0. +- In the develop branch, the version should match the upcoming release like X.Y.Z-betaN diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst new file mode 100644 index 0000000000..e9a5704372 --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst @@ -0,0 +1,9 @@ +Update Version Number for Release +--------------------------------- + +Update the version number for the bugfix release: + +* For METplotpy, the file containing the version number is located at docs/version. +* If the current release is listed as X.Y.Z (major.minor.micro), the bugfix version should be X.Y.Z+1 + (i.e. increment the micro value by 1: 1.1.0 becomes 1.1.1) + diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst new file mode 100644 index 0000000000..127fa7d27f --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst @@ -0,0 +1,15 @@ +Update Version Number for Release +--------------------------------- + +Remove **-dev** from the version number: + +* We are naming releases with X.Y.Z format even if Z is 0. +* The file containing the version number is located at docs/version. +* In the develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev +* Remove **-dev** from the version number so that it matches the release you are creating. + +Update the version number in the quick search links: + +* Open the docs/Users_Guide/quicksearch.rst file for editing. +* Replace the word "develop" in all of the links with "vX.Y.Z", replacing the X.Y.Z with the version number. For example, replace "develop" with "v4.0.0". +* Save and close the file. diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst new file mode 100644 index 0000000000..ff744d7bbe --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst @@ -0,0 +1,20 @@ +Update Version on Develop Branch +-------------------------------- + +Change METplotpy/docs/version __version__ value to the next release after this one with -dev added +to the end. Releases will loosely following these names, but are subject to +change: + ++-------------------+-----------------------+ +| Release Version | New Develop Version | ++===================+=======================+ +| X.Y.Z-beta1 | X.Y.Z-beta2-dev | ++-------------------+-----------------------+ +| X.Y.Z-beta2 | X.Y.Z-beta3-dev | ++-------------------+-----------------------+ +| X.Y.Z-beta3 | X.Y.Z-rc1-dev | ++-------------------+-----------------------+ +| X.Y.Z-rc1 | X.Y.Z-dev | ++-------------------+-----------------------+ +| X.Y.Z | (X+1).0.0-beta1-dev | ++-------------------+-----------------------+ From 755536c3ae135da367cffdf567a5606d38c5c6c9 Mon Sep 17 00:00:00 2001 From: TatianaBurek Date: Tue, 27 Apr 2021 09:13:09 -0600 Subject: [PATCH 02/22] change METplotpy to METviewer and added extra steps #673 --- docs/Release_Guide/release_steps/metviewer/update_version.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Release_Guide/release_steps/metviewer/update_version.rst b/docs/Release_Guide/release_steps/metviewer/update_version.rst index 536a9bba15..f55a9408d6 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version.rst @@ -3,6 +3,8 @@ Update Version Number for Release Create the version number -- In the METplotpy/docs/version file, assign the version to the '__version__' keyword +- In the METviewer/docs/version file, assign the version to the '__version__' keyword +- In the METviewer/build.xml file, assign the version in the 'dist' target +- In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to
and - We are naming releases with X.Y.Z format even if Z is 0. - In the develop branch, the version should match the upcoming release like X.Y.Z-betaN From f79112e06b539f215a556894ead8f7aa42907193 Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Tue, 27 Apr 2021 09:13:30 -0600 Subject: [PATCH 03/22] change METplotpy to METviewer #673 --- .../release_steps/metviewer/update_version_on_develop.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst index ff744d7bbe..5488628e10 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst @@ -1,7 +1,7 @@ Update Version on Develop Branch -------------------------------- -Change METplotpy/docs/version __version__ value to the next release after this one with -dev added +Change METviewer/docs/version __version__ value to the next release after this one with -dev added to the end. Releases will loosely following these names, but are subject to change: From 3c6a31d9e62ba9566e5697fb9864a85d83ad080b Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Tue, 27 Apr 2021 09:14:14 -0600 Subject: [PATCH 04/22] remove unused update_dtc_website step #673 --- docs/Release_Guide/metviewer_development.rst | 1 - .../release_steps/metviewer/update_dtc_website.rst | 5 ----- 2 files changed, 6 deletions(-) delete mode 100644 docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 2830a8060d..6a4bb2af03 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -14,7 +14,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metviewer/create_release_extra.rst -.. include:: release_steps/metviewer/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/metviewer/update_version_on_develop.rst diff --git a/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst deleted file mode 100644 index 8b5fb6554a..0000000000 --- a/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. include:: release_steps/common/update_dtc_website.rst - -.. |projectName| replace:: METplus Wrappers - -.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab. \ No newline at end of file From 64e70ec0eb68e092efd0015278952460c0ab322a Mon Sep 17 00:00:00 2001 From: bikegeek <minnawin@ucar.edu> Date: Thu, 29 Apr 2021 16:19:17 -0600 Subject: [PATCH 05/22] Copy of instructions for updating the DTC website. --- .../release_steps/metviewer/update_dtc_website.rst | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst diff --git a/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst new file mode 100644 index 0000000000..8b5fb6554a --- /dev/null +++ b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst @@ -0,0 +1,5 @@ +.. include:: release_steps/common/update_dtc_website.rst + +.. |projectName| replace:: METplus Wrappers + +.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab. \ No newline at end of file From b24e4c43681c9e5a140c40bb59566e46f6e27b8e Mon Sep 17 00:00:00 2001 From: bikegeek <minnawin@ucar.edu> Date: Thu, 29 Apr 2021 16:20:01 -0600 Subject: [PATCH 06/22] Added step to update DTC website --- docs/Release_Guide/metviewer_development.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 6a4bb2af03..e84e307610 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -13,6 +13,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/metviewer/update_docs_develop.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst +.. include:: release_steps/metviewer/update_dtc_website.rst .. include:: release_steps/metviewer/create_release_extra.rst .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/metviewer/update_version_on_develop.rst From b58dc60e441a614ce541006d94f3197896feb370 Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Tue, 4 May 2021 11:19:21 -0600 Subject: [PATCH 07/22] updated bugfix and official METviewer docs #673 --- docs/Release_Guide/metviewer_bugfix.rst | 2 -- docs/Release_Guide/metviewer_official.rst | 1 - .../release_steps/metviewer/update_docs_tagged.rst | 2 +- .../release_steps/metviewer/update_version_bugfix.rst | 5 ++++- .../release_steps/metviewer/update_version_official.rst | 2 ++ 5 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst index c060c6bf42..53355c4938 100644 --- a/docs/Release_Guide/metviewer_bugfix.rst +++ b/docs/Release_Guide/metviewer_bugfix.rst @@ -10,10 +10,8 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/checkout_main_branch.rst .. include:: release_steps/metviewer/update_version_bugfix.rst .. include:: release_steps/update_release_notes_bugfix.rst -.. include:: release_steps/metviewer/update_docs_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metviewer/create_release_extra.rst -.. include:: release_steps/metviewer/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_official.rst diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index b0c9715ae3..b4167c9b12 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -16,7 +16,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/push_release_branch.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metviewer/create_release_extra.rst -.. include:: release_steps/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/metviewer/update_version_on_develop.rst diff --git a/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst b/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst index 31ac770ceb..962809a719 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst @@ -13,4 +13,4 @@ Update the Documentation on the Web * Update symbolic link for 'latest' to point to new version. * Commit changes and push to GitHub. * Verify that documentation appears in the pull-down and latest points to the - new version on the web: dtcenter.github.io/METplus + new version on the web: dtcenter.github.io/METviewer diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst index e9a5704372..e10fa8adb0 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst @@ -3,7 +3,10 @@ Update Version Number for Release Update the version number for the bugfix release: -* For METplotpy, the file containing the version number is located at docs/version. +* For METviewer, the file containing the version number is located at docs/version. * If the current release is listed as X.Y.Z (major.minor.micro), the bugfix version should be X.Y.Z+1 (i.e. increment the micro value by 1: 1.1.0 becomes 1.1.1) +* In the METviewer/build.xml file, assign the version in the 'dist' target +* In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to <div id='release'> and <title> + diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst index 127fa7d27f..a74960296c 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst @@ -5,6 +5,8 @@ Remove **-dev** from the version number: * We are naming releases with X.Y.Z format even if Z is 0. * The file containing the version number is located at docs/version. +* In the METviewer/build.xml file, assign the version in the 'dist' target +* In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to <div id='release'> and <title> * In the develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev * Remove **-dev** from the version number so that it matches the release you are creating. From ec2e6f04bcfc155fc8d69ff6fe50c1ee990f113e Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 11:45:02 -0600 Subject: [PATCH 08/22] deleted based on Julie's suggestion: it is no longer necessary to a manual build of the documentation now that ReadtheDocs is in place. #673 --- .../metviewer/update_docs_bugfix.rst | 11 ----------- .../metviewer/update_docs_develop.rst | 11 ----------- .../metviewer/update_docs_tagged.rst | 16 ---------------- 3 files changed, 38 deletions(-) delete mode 100644 docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst delete mode 100644 docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst delete mode 100644 docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst diff --git a/docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst b/docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst deleted file mode 100644 index f48f7a43d3..0000000000 --- a/docs/Release_Guide/release_steps/metviewer/update_docs_bugfix.rst +++ /dev/null @@ -1,11 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Build the documentation with the correct conda environment by entering the - docs directory and running: `make clean;make html` - -* In another directory, checkout the gh-pages branch of repository. -* Put all contents of docs/_build/html into the directory for the major/minor release, - i.e. vX.Y.Z -* Commit changes and push to GitHub. -* Verify that documentation is updated on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst b/docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst deleted file mode 100644 index 82c9e572f7..0000000000 --- a/docs/Release_Guide/release_steps/metviewer/update_docs_develop.rst +++ /dev/null @@ -1,11 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation <https://dtcenter.github.io/METplus/develop/Contributors_Guide/add_use_case.html#build-the-documentation>`_. -* Build the documentation with the correct conda environment by entering the - docs directory and running `make clean;make html` -* In another directory, checkout the gh-pages branch of repository. -* On the gh-pages branch, remove all contents of develop directory. -* Put all contents of docs/_build/html into the develop directory. -* Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst b/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst deleted file mode 100644 index 962809a719..0000000000 --- a/docs/Release_Guide/release_steps/metviewer/update_docs_tagged.rst +++ /dev/null @@ -1,16 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation <https://dtcenter.github.io/METplus/develop/Contributors_Guide/add_use_case.html#build-the-documentation>`_. -* Build the documentation with the correct conda environment by entering the - docs directory and running `make clean;make html` -* In another directory, checkout the gh-pages branch of repository. -* Create a new directory in the gh-pages branch for the release appending a - "v" to the front, i.e. vX.Y.Z -* Put all contents of docs/_build/html into the directory. -* Update versions.json to add the new directory name. -* Update symbolic link for 'latest' to point to new version. -* Commit changes and push to GitHub. -* Verify that documentation appears in the pull-down and latest points to the - new version on the web: dtcenter.github.io/METviewer From d393cb41c1410ca34cd39c6fc1d658a5fc5276d7 Mon Sep 17 00:00:00 2001 From: Tatiana Burek <tatiana@ucar.edu> Date: Fri, 7 May 2021 11:46:42 -0600 Subject: [PATCH 09/22] Update docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst Co-authored-by: jprestop <jpresto@ucar.edu> --- .../release_steps/metviewer/update_dtc_website.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst index 8b5fb6554a..464371828a 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst @@ -1,5 +1,5 @@ .. include:: release_steps/common/update_dtc_website.rst -.. |projectName| replace:: METplus Wrappers +.. |projectName| replace:: |projectRepo| -.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab. \ No newline at end of file +.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab. From 4390ed55d4d2c373f2ee2f75a678101584b3ec6b Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 11:48:13 -0600 Subject: [PATCH 10/22] quicksearch.rst is removed as there is no docs/Users_Guide/quicksearch.rst for METviewer documentation.#673 --- .../release_steps/metviewer/update_version_official.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst index a74960296c..238a5c7d49 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst @@ -10,8 +10,5 @@ Remove **-dev** from the version number: * In the develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev * Remove **-dev** from the version number so that it matches the release you are creating. -Update the version number in the quick search links: - -* Open the docs/Users_Guide/quicksearch.rst file for editing. * Replace the word "develop" in all of the links with "vX.Y.Z", replacing the X.Y.Z with the version number. For example, replace "develop" with "v4.0.0". * Save and close the file. From 9feee54a5dc73c097f863cc89acbef452628cb52 Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 11:49:20 -0600 Subject: [PATCH 11/22] quicksearch.rst is removed as there is no docs/Users_Guide/quicksearch.rst for METviewer documentation.#673 --- .../release_steps/metviewer/update_version_official.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst index 238a5c7d49..2a09180be2 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst @@ -10,5 +10,4 @@ Remove **-dev** from the version number: * In the develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev * Remove **-dev** from the version number so that it matches the release you are creating. -* Replace the word "develop" in all of the links with "vX.Y.Z", replacing the X.Y.Z with the version number. For example, replace "develop" with "v4.0.0". * Save and close the file. From 74c83082d5f0e1d796b34958b7889c459aaa9d9f Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 11:50:18 -0600 Subject: [PATCH 12/22] quicksearch.rst is removed as there is no docs/Users_Guide/quicksearch.rst for METviewer documentation.#673 --- .../release_steps/metviewer/update_version_official.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst index 2a09180be2..1c1db5940e 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst @@ -7,7 +7,5 @@ Remove **-dev** from the version number: * The file containing the version number is located at docs/version. * In the METviewer/build.xml file, assign the version in the 'dist' target * In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to <div id='release'> and <title> -* In the develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev -* Remove **-dev** from the version number so that it matches the release you are creating. * Save and close the file. From b85b0c35ff77c815b61da0532015ee39e8e2590b Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 11:52:13 -0600 Subject: [PATCH 13/22] update_docs_develop.rst is removed because we have moved to ReadtheDocs and the steps listed in update_docs_develop.rst are no longer relevant. #673 --- docs/Release_Guide/metviewer_development.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index b0f02623f1..4551479ce9 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metviewer/update_version.rst .. include:: release_steps/update_release_notes_development.rst -.. include:: release_steps/metviewer/update_docs_develop.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metviewer/update_dtc_website.rst From e2cfb8387b8a58e70d8cdf327461d640237c7609 Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 11:53:19 -0600 Subject: [PATCH 14/22] update_docs_tagged.rst is removed because we have moved to ReadtheDocs and the steps listed in update_docs_tagged.rst are no longer relevant. #673 --- docs/Release_Guide/metviewer_official.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index 17d5324ae4..719c26e648 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metviewer/update_version_official.rst .. include:: release_steps/update_release_notes_official.rst -.. include:: release_steps/metviewer/update_docs_tagged.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_branch.rst .. include:: release_steps/push_release_branch.rst From e5f3726362db7aaae83916e137c21cc1be89e9a2 Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 12:04:14 -0600 Subject: [PATCH 15/22] added create_release_feature_branch.rst #673 --- docs/Release_Guide/metviewer_bugfix.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst index 53355c4938..27cf83df24 100644 --- a/docs/Release_Guide/metviewer_bugfix.rst +++ b/docs/Release_Guide/metviewer_bugfix.rst @@ -8,6 +8,7 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/open_release_issue.rst .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_main_branch.rst +.. include:: release_steps/create_release_feature_branch.rst .. include:: release_steps/metviewer/update_version_bugfix.rst .. include:: release_steps/update_release_notes_bugfix.rst .. include:: release_steps/merge_release_issue.rst From 19f792deadebc22f6a97e2ca6d6f30c530db0a1d Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 12:06:10 -0600 Subject: [PATCH 16/22] added create_release_feature_branch.rst #673 --- docs/Release_Guide/metviewer_development.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 4551479ce9..3a099dc28f 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -8,6 +8,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/open_release_issue.rst .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_develop_branch.rst +.. 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/merge_release_issue.rst From 04b32cf064da4de3b2fd45291f55300062897afc Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 12:07:09 -0600 Subject: [PATCH 17/22] added create_release_feature_branch.rst #673 --- docs/Release_Guide/metviewer_official.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index 719c26e648..dcb07ac0e2 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -8,6 +8,7 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/open_release_issue.rst .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_develop_branch.rst +.. 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/merge_release_issue.rst From d568e442585e1ec68ffb47fe3595622ee70c4b1e Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 12:10:33 -0600 Subject: [PATCH 18/22] moved create_release_extra.rst and deleted update_dtc_website.rst #673 --- docs/Release_Guide/metviewer_development.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 3a099dc28f..fe5028cf5e 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -13,7 +13,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/update_release_notes_development.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst -.. include:: release_steps/metviewer/update_dtc_website.rst .. include:: release_steps/metviewer/create_release_extra.rst .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/metviewer/update_version_on_develop.rst From 642b7c7fd7a0b14bd2a8afaed93f8ad185595889 Mon Sep 17 00:00:00 2001 From: TatianaBurek <tatiana@ucar.edu> Date: Fri, 7 May 2021 12:16:08 -0600 Subject: [PATCH 19/22] added update_docs_official.rst #673 --- docs/Release_Guide/metviewer_official.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index dcb07ac0e2..6b8dcbc48b 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -18,4 +18,5 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/metviewer/create_release_extra.rst .. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/metviewer/update_version_on_develop.rst +.. include:: release_steps/update_docs_official.rst From fe345065de7371c71e593374d43041b7c19d68ef Mon Sep 17 00:00:00 2001 From: "Julie.Prestopnik" <jpresto@ucar.edu> Date: Fri, 7 May 2021 14:22:15 -0600 Subject: [PATCH 20/22] Added update_dtc_website.rst to metviewer_bugfix.rst and metviewer_official.rst --- docs/Release_Guide/metviewer_bugfix.rst | 1 + docs/Release_Guide/metviewer_official.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst index 27cf83df24..45d70f828e 100644 --- a/docs/Release_Guide/metviewer_bugfix.rst +++ b/docs/Release_Guide/metviewer_bugfix.rst @@ -14,5 +14,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metviewer/create_release_extra.rst +.. include:: release_steps/metviewer/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_official.rst diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index 6b8dcbc48b..0e2206e646 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -16,6 +16,7 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/push_release_branch.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metviewer/create_release_extra.rst +.. include:: release_steps/metviewer/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/metviewer/update_version_on_develop.rst .. include:: release_steps/update_docs_official.rst From e093938e1d6976e05e22ecfecf61c4e8a4d520c4 Mon Sep 17 00:00:00 2001 From: "Julie.Prestopnik" <jpresto@ucar.edu> Date: Fri, 7 May 2021 14:23:45 -0600 Subject: [PATCH 21/22] Added rotate_authorship.rst to met_viewer_official.rst --- docs/Release_Guide/metviewer_official.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index 0e2206e646..c4da36ee2b 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/rotate_authorship.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_branch.rst .. include:: release_steps/push_release_branch.rst From 7276159ec2cb7a0a75091099fcab3ed42b8884fc Mon Sep 17 00:00:00 2001 From: "Julie.Prestopnik" <jpresto@ucar.edu> Date: Fri, 7 May 2021 14:28:29 -0600 Subject: [PATCH 22/22] Added .. include:: release_steps/metviewer/update_dtc_website.rst --- docs/Release_Guide/metviewer_development.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index fe5028cf5e..b1de3adb02 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -14,5 +14,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metviewer/create_release_extra.rst +.. include:: release_steps/metviewer/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/metviewer/update_version_on_develop.rst