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 documentation to reflect recent (Feb '24) changes #72

Merged
merged 35 commits into from
Mar 14, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Mar 5, 2024

Description

This PR includes the following updates:

  • Rename docs to doc for NCO compliance
  • Build/Run Chapter: New instructions for running the workflow on Level 1 systems
  • Technical Overview: Updated repository structure diagrams and related info; added UW info
  • Add FAQ chapter
  • Glossary updates
  • Add linkchecker
  • Add UFS/EPIC logo
  • Requirements update

Anticipated changes to regression tests:

  • Is baseline change expected ? No.

Subcomponents involved:

  • DA_update (ufs-community/land-DA)
  • ufsLand.fd (NOAA-EPIC/ufs-land-driver-emc-dev)
  • ufs_model.fd (ufs-community/ufs-weather-model)
  • vector2tile_converter.fd (NOAA-PSL/land-vector2tile)
  • none

Linked PR's and Issues:

Closes #59 & #71

Testing (for CM's):

  • RDHPCS
    • Hera
    • Orion
    • Jet
    • Gaea
    • Cheyenne
  • CI
    • Completed
  • PW-Clouds
    • AWS
    • AZURE
    • GCP

@gspetro-NOAA gspetro-NOAA changed the title [develop]: Update documentation to reflect recent changes [develop]: Update documentation to reflect recent (Feb '24) changes Mar 5, 2024
@gspetro-NOAA
Copy link
Collaborator Author

@chan-hoo The Land DA documentation build is failing, but I think it may be due to the change from docs to doc. The docs build without error on my system and in my RTD account for my fork (view docs here). I updated the auto_doc.yaml file, but I'm not sure if there are other adjustments that need to be made.

@chan-hoo chan-hoo linked an issue Mar 7, 2024 that may be closed by this pull request
@gspetro-NOAA gspetro-NOAA marked this pull request as ready for review March 11, 2024 20:55
@chan-hoo
Copy link
Collaborator

@gspetro-NOAA, can you merge the develop branch into your PR. I don't know why the build test failed.

@gspetro-NOAA
Copy link
Collaborator Author

@chan-hoo It's been failing for a while now. I tried to update .github/workflows/auto_doc.yml in the hope that that would solve the problem. My guess is that it related to the change from docs to doc. The docs on my fork build without a problem. You can see the passing build status for my fork here.

@chan-hoo
Copy link
Collaborator

@gspetro-NOAA, yes. I agree with you. Approving. @jkbk2004, if you have any comments, please let us know. Otherwise, we can merge this PR.

chan-hoo
chan-hoo previously approved these changes Mar 14, 2024
jkbk2004
jkbk2004 previously approved these changes Mar 14, 2024
@gspetro-NOAA gspetro-NOAA dismissed stale reviews from jkbk2004 and chan-hoo via 12a794b March 14, 2024 21:10
@gspetro-NOAA
Copy link
Collaborator Author

@chan-hoo I added a Read The Docs integration that builds the PR docs. Since it has passed, it seems like the problem is with the repo's CI/CD, likely the docs/doc discrepancy. I think it should be safe to merge, but your call.

@chan-hoo chan-hoo merged commit 1b77d1f into ufs-community:develop Mar 14, 2024
1 of 2 checks passed
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.

Update documentation with wflow changes from February 2024 PRs Rename 'docs' to 'doc'
3 participants