Skip to content

[develop] Add ccpp-scm reference#842

Merged
MichaelLueken merged 3 commits into
ufs-community:developfrom
clouden90:ccpp-scm-ref
Jun 26, 2023
Merged

[develop] Add ccpp-scm reference#842
MichaelLueken merged 3 commits into
ufs-community:developfrom
clouden90:ccpp-scm-ref

Conversation

@clouden90
Copy link
Copy Markdown
Contributor

DESCRIPTION OF CHANGES:

The reference of CCPP-SCM was missing in #822. Here we add it back.

DEPENDENCIES:

#822

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

Copy link
Copy Markdown
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.

@clouden90 Rather than just referring to sections in the User's Guide, I think it is best to provide a direct link to section 5.2 and 2.5. I'm also concerned about the details of section 5.2 (Running the SRW App's Grid Configuration section) and 2.5 (There is no section 2.5 in the user's guide, Chapter 2 only goes to 2.2 Quick Start Guide's Building and Running the UFS SRW Application). Are you sure that these are the sections that you want to point to here?

Comment thread docs/UsersGuide/source/Components.rst Outdated
Copy link
Copy Markdown
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.

Now that the Components.rst section has been updated to note that the sections are in the CCPP-SCM User's Guide, rather than the SRW App's User Guide, I will go ahead and approve these changes.

@MichaelLueken MichaelLueken added the documentation Improvements or additions to documentation label Jun 23, 2023
@MichaelLueken MichaelLueken changed the title add ccpp-scm reference [develop] Add ccpp-scm reference Jun 23, 2023
@MichaelLueken
Copy link
Copy Markdown
Collaborator

This is an emergency PR to add the CCPP-SCM documentation into the Components.rst file. This is required for an EPIC deliverable, so it is imperative that this gets reviewed as soon as possible so that it can get merged. Thank you very much!

@MichaelLueken
Copy link
Copy Markdown
Collaborator

Thanks for the review, @chan-hoo! I will now move forward with merging this work.

@MichaelLueken MichaelLueken merged commit cb1864d into ufs-community:develop Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants