[release/public-v2.1.0]: Update the docs, add an errata file #557
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
natalie-perlin
requested review from
mkavulich,
gsketefian,
JeffBeck-NOAA,
RatkoVasic-NOAA,
BenjaminBlake-NOAA,
ywangwof,
chan-hoo,
panll,
christinaholtNOAA,
christopherwharrop-noaa,
danielabdi-noaa,
mark-a-potts,
jkbk2004,
willmayfield,
dmwright526,
gspetro-NOAA,
EdwardSnyder-NOAA and
MichaelLueken
as code owners
natalie-perlin
removed request for
mkavulich,
panll,
dmwright526,
gsketefian,
mark-a-potts,
christopherwharrop-noaa,
RatkoVasic-NOAA,
jkbk2004,
ywangwof and
danielabdi-noaa
natalie-perlin
requested review from
danielabdi-noaa,
EdwardSnyder-NOAA,
mark-a-potts,
MichaelLueken,
mkavulich and
willmayfield
and removed request for
BenjaminBlake-NOAA,
JeffBeck-NOAA,
christinaholtNOAA,
willmayfield,
chan-hoo,
MichaelLueken and
EdwardSnyder-NOAA
There was a problem hiding this comment.
@natalie-perlin Thanks for adding the necessary commands to make the wrapper scripts work to the documentation and the errata file! The only request I have is to replace the <release-tag> entry with ufs-srw-v2.1.0, the name of the release tag. Otherwise, these changes look good to me!
Update the tag name for the release
MichaelLueken
added
documentation
MichaelLueken
approved these changes
Jan 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIPTION OF CHANGES:
Updates to the Users Guide, Session on running the SRW on MacOS and generic Linux using standalone wrapper scripts. An errata file is added to the main directory.
Files changed:
./docs/UsersGuide/source/RunSRW.rst
./ERRATA.md (new file)
Type of change
TESTS CONDUCTED:
DEPENDENCIES:
DOCUMENTATION:
This PR updated the documentation for the release/public-v2.1.0 branch.
ISSUE:
This PR resolves the issue #473
The issue has also been mentioned and discussed in the PR #507 and #508.
CHECKLIST
LABELS (optional):
A Code Manager needs to add the following labels to this PR:
CONTRIBUTORS (optional):