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

[develop] Update SRW reference chapter #1184

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

selbigmtnwx23
Copy link

--- Delete this line and those above before hitting "Create pull request" ---

DESCRIPTION OF CHANGES:

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

TESTS CONDUCTED:

  • derecho.intel
  • gaea.intel
  • gaea-c6.intel
  • hera.gnu
  • hera.intel
  • hercules.intel
  • jet.intel
  • orion.intel
  • wcoss2.intel
  • NOAA Cloud (indicate which platform)
  • Jenkins
  • fundamental test suite
  • comprehensive tests (specify which if a subset was used)

DEPENDENCIES:

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
  • 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).
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

LABELS (optional):

A Code Manager needs to add the following labels to this PR:

  • Work In Progress
  • bug
  • enhancement
  • documentation
  • release
  • high priority
  • run_ci
  • run_we2e_fundamental_tests
  • run_we2e_comprehensive_tests
  • Needs Cheyenne test
  • Needs Jet test
  • Needs Hera test
  • Needs Orion test
  • help wanted

CONTRIBUTORS (optional):

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.

@selbigmtnwx23 -

Thanks for adding the updates from the Technical-FAQs site to the SRW App's documentation!

I do have two concerns:

  1. The .. _AddPhys: entry on line 209 should be moved down to after the newly added frequently asked questions so that it matches up with the add physics scheme FAQ.
  2. The devclean.sh convenience script has changed and --clean is no longer an option. I have provided a suggested change for this FAQ entry.

Following these modifications, I should be able to provide my approval to for this PR.

doc/UsersGuide/Reference/FAQ.rst Outdated Show resolved Hide resolved
doc/UsersGuide/Reference/FAQ.rst Show resolved Hide resolved
@MichaelLueken
Copy link
Collaborator

The failed Doc Tests won't keep this PR from getting merged. The security certificate for the https://www.fvcom.org/ site has expired and the failure isn't due to changes in this PR.

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.

@selbigmtnwx23 -

Thanks for applying the modifications related to the devclean.sh convenience script! The updates look good to me, so I will go ahead and approve these now.

@@ -21,7 +21,7 @@ Quick Start Guide (SRW-AQM)

.. attention::

These instructions should work smoothly on Hera and WCOSS2, but users on other systems may need to make additional adjustments.
These instructions should work smoothly on Hera, Hercules, Derecho and Orion but users on other systems may need to make additional adjustments.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Missing comma after Derecho

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants