-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[develop] Pull in relevant doc updates from release v2.1.0 #498
[develop] Pull in relevant doc updates from release v2.1.0 #498
Conversation
This reverts commit b839658.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gspetro-NOAA I have some comments related to the changes to the plotting scripts, but otherwise, the documentation changes look good to me.
For the modification to the plotting scripts, was it decided that these changes weren't necessary? It sounded like a mismatch between grib2
field naming for Geopotential Height
was causing the scripts to fail (leading to the changing of the name originally). If this is no longer an issue, then I'm fine with changing Geopotential height
back to Geopotential Height
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gspetro-NOAA Thanks for making the modifications to the plotting scripts! Approving the PR now.
Is this work ready to be merged, or would you like for more eyes to look over it before it is merged?
@natalie-perlin wanted to take a look, so she's about to do that right now. |
Thanks, @gspetro-NOAA! I will wait for @natalie-perlin approval before merging this work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glossary.rst, add the following to the end of line 121:
Updated documentation could be found at :doc:HPC-Stack documentation <hpc-stack:index>
.
Introduction.rst, change in line 9 (partial):
... New and improved capabilities for the v2.1.0 release included the addition of a verification package (METplus)...
Quickstart.rst, line 12 (partial) changes:
... (2) configuring the stack to specify compilers, compiler options, and installation directory and (3) specifying the software packages and versions to be built, and building the stack that downloads necessary repositories or archives to build the requested packages. This process will create a number of modulefiles needed to build SRW App.
@natalie-perlin and @gspetro-NOAA For the modification to
This sentence appears to be a carry over from |
@natalie-perlin I made the Glossary update. Also added the Quickstart changes with slight rewording, but it seems that if users are just installing the default HPC-Stack, they wouldn't have to specify packages. I say "At a minimum..." so I want to be sure that specifying packages IS actually a required step. |
@gspetro-NOAA This makes sense to me. Since this latest release is just a minor release, it is fine to keep the major updates from the version 2 major release in the introduction. I'm fine with keeping the introduction as it currently is in this PR. |
DESCRIPTION OF CHANGES:
The documentation was thoroughly revised for the v2.1.0 release, and some of those updates are relevant to the
develop
branch. This PR adds those updates to develop.Type of change
TESTS CONDUCTED:
None required. Reviewed the docs on my fork's Read the Docs site: https://srw-ug.readthedocs.io/en/text-updates/
DEPENDENCIES:
N/A.
DOCUMENTATION:
All documentation.
ISSUE:
Fixes issue #497 .
CHECKLIST