Feature 2932 v12.0.0-beta5

jprestop commented 1 month ago

Expected Differences

[x] Do these changes introduce new tools, command line arguments, or configuration file options? [No]
If yes, please describe:
[x] Do these changes modify the structure of existing or add new output data types (e.g. statistic line types or NetCDF variables)? [No]
If yes, please describe:

[x] Describe testing already performed for these changes:
None
[x] Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
Review the beta5 release notes at this link: MET Version 12.0.0-beta5 Release Notes (20240710) Pay particular attention to the items that are bolded. I used my best judgement based on the priority tags listed on the issues, but would appreciate any feedback you have to give and requests for any changes.
[x] Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]
[x] Do these changes include sufficient testing updates? [Yes]
[x] Will this PR result in changes to the MET test suite? [No]
If yes, describe the new output and/or changes to the existing output:
[x] Will this PR result in changes to existing METplus Use Cases? [No]
If yes, create a new Update Truth METplus issue to describe them.
[x] Do these changes introduce new SonarQube findings? [No]
If yes, please describe:
[x] Please complete this pull request review by [20240710 AM].

See the METplus Workflow for details.

[x] Review the source issue metadata (required labels, projects, and milestone).
[x] Complete the PR definition above.
[x] Ensure the PR title matches the feature or bugfix branch name.
[x] Define the PR metadata, as permissions allow. Select: Reviewer(s) and Development issue Select: Milestone as the version that will include these changes Select: Coordinated METplus-X.Y Support project for bugfix releases or MET-X.Y.Z Development project for official releases
[x] After submitting the PR, select the :gear: icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
[ ] After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
[ ] Close the linked issue and delete your feature or bugfix branch from GitHub.

JohnHalleyGotway commented 1 month ago

Alright Julie, thanks for putting together these release notes. I made some significant changes, listed below:

Fixed one minor typo #3717 to #2717.
Moved METbaseimage issue to the top of the list to keep them organized by repo. I'm torn on whether it belong here since we do have release notes in this README file. But I'll just leave it since you put it here.
Reworded titles of all bugfix issues/release notes to begin with Fix <TOOL NAME> ....
Reworded other issue titles for consistency/clarity.
Reordered the notes to put the issues in numeric order within each section.
Unbolded several enhancements to minimize the number of bolds. If "everything" is emphasized, then nothing is. I generally highlight new command line options, config file options, new statistics output, and major changes to functionality. But this is very subjective.
Added back in back-ticks around config/command line options to format them nicely in the release notes. They don't survive copy/paste generally.

Here's the commit with those changes.

JohnHalleyGotway commented 1 month ago

FYI, I just removed the inline backticks because do not format the way I expected, especially when used inside release notes that are bolded.