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]: Add Contributor's Guide to documentation #1046

Merged
merged 30 commits into from
Mar 1, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Feb 23, 2024

DESCRIPTION OF CHANGES:

This PR adds a Contributor's Guide to the docs alongside the User's Guide.
The Contributor's Guide includes general information on use of Git submodules in the UFS. This information can be adapted in a future PR to be more SRW-specific based on user needs/requests and any training we provide.
This PR also configures the docs so that Technical Documentation can be easily added at a later date.

Type of change

  • This change requires a documentation update

TESTS CONDUCTED:

None required. See doc build below.

DEPENDENCIES:

N/A.

DOCUMENTATION:

All documentation.

ISSUE:

Issue #1016

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 - N/A
  • Any dependent changes have been merged and published

CONTRIBUTORS (optional):

Janet Derrico @jderrico-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.

Hi @gspetro-NOAA! Thank you very much for adding the Contributor's Guide to RTD! Overall, these changes look good!

I have noted that it might be best to remove the run_we2e_comprehensive_tests label until that functionality is added to the pipeline. Additionally, given their change from EMC to EPIC, I would like to give @RatkoVasic-NOAA and @chan-hoo the opportunity to update their Areas of Expertise in the code-managers.csv file, as well as adding Brian Curtis, who will be in charge of the Operational AQM/Online-CMAQ for EMC.

doc/ContribGuide/testing.rst Outdated Show resolved Hide resolved
doc/tables/code-managers.csv Outdated Show resolved Hide resolved
doc/tables/code-managers.csv Outdated Show resolved Hide resolved
doc/tables/code-managers.csv 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, for making my requested modifications! I will go ahead and approve these changes now (will hold off on merging until the last conversation in code-managers.csv has been resolved).

@MichaelLueken MichaelLueken added the documentation Improvements or additions to documentation label Feb 27, 2024
@MichaelLueken MichaelLueken merged commit 6d6c6af into ufs-community:develop Mar 1, 2024
2 checks passed
@gspetro-NOAA gspetro-NOAA deleted the text/us-146 branch September 26, 2024 20:55
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.

Add Contributor's Guide to documentation and include Git submodule information
5 participants