Skip to content
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

[release/public-v2.1.0] Documentation Updates #483

Merged
merged 68 commits into from
Nov 17, 2022
Merged

[release/public-v2.1.0] Documentation Updates #483

merged 68 commits into from
Nov 17, 2022

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Nov 16, 2022

DESCRIPTION OF CHANGES:

Final (hopefully) documentation updates for the SRW v2.1.0 release. Updates include:

  • What's new in this release section & link to info on CCPP updates
  • Minor updates, clarifications, and corrections throughout
  • Updates for generic MacOS/Linux systems
  • Revision of LAM Grid section on user-defined grids
  • Expanded Glossary & FAQ

Type of change

  • This change requires a documentation update (all docs!)

TESTS CONDUCTED:

None required. Checked various parts of the instructions on the following systems:

  • hera.intel
  • jet.intel
  • NOAA Cloud (Azure)

DEPENDENCIES:

N/A.

DOCUMENTATION:

All documentation.

ISSUE:

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas (N/A)
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain). (N/A)
  • My changes generate no new warnings
  • New and existing tests pass with my changes (no tests required)
  • Any dependent changes have been merged and published (N/A)

CONTRIBUTORS (optional):

@natalie-perlin @mark-a-potts

docs/UsersGuide/source/BuildSRW.rst Show resolved Hide resolved
docs/UsersGuide/source/Components.rst Show resolved Hide resolved
docs/UsersGuide/source/ConfigWorkflow.rst Show resolved Hide resolved
docs/UsersGuide/source/Components.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/ContributorsGuide.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/ContributorsGuide.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/Glossary.rst Show resolved Hide resolved
docs/UsersGuide/source/Graphics.rst Show resolved Hide resolved
docs/UsersGuide/source/LAMGrids.rst Show resolved Hide resolved
docs/UsersGuide/source/ContributorsGuide.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/Graphics.rst Show resolved Hide resolved
docs/UsersGuide/source/Graphics.rst Show resolved Hide resolved
docs/UsersGuide/source/LAMGrids.rst Show resolved Hide resolved
@MichaelLueken MichaelLueken added the release This PR/issue is related to a release branch label Nov 17, 2022
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gspetro-NOAA Great work! I have a few comments for RunSRW.rst, but overall, this release documentation looks good.

docs/UsersGuide/source/RunSRW.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@JeffBeck-NOAA JeffBeck-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all your work on the documentation, @gspetro-NOAA!

Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two more minor issues with the cron interval in RunSRW.rst. Once adjusted, you should be good to go with merging this to the release branch. Thanks!

docs/UsersGuide/source/RunSRW.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/RunSRW.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gspetro-NOAA! Everything looks good to me.

@gspetro-NOAA gspetro-NOAA merged commit 2e08cce into ufs-community:release/public-v2.1.0 Nov 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release This PR/issue is related to a release branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants