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]: Quarterly Documentation Update (PI11) #1014

Merged
merged 11 commits into from
Feb 15, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

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

DESCRIPTION OF CHANGES:

Updates include:

  • Edits to ConfigWorkflow.rst to align it with the current config_defaults.yaml
  • Addition of new FAQs
  • Improve flow of the container chapter by moving extra info to an appendix rather than including it in the main container instructions.
  • Add a make linkcheck function to documentation Makefile to check for any problems with links and fix issues w/links

Type of change

  • This change requires a documentation update

TESTS CONDUCTED:

None required for documentation. The docs build successfully on my fork and can be viewed at: https://gsp-srw.readthedocs.io/en/text-us-25/

DEPENDENCIES:

N/A

DOCUMENTATION:

All documentation.

ISSUE:

Issue #1013

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

CONTRIBUTORS:

@maddenp-noaa

@MichaelLueken MichaelLueken linked an issue Feb 8, 2024 that may be closed by this pull request
@gspetro-NOAA
Copy link
Collaborator Author

@MichaelLueken Currently, the make linkcheck command highlights 2 "broken" links, both from Intel. These links work in the browser, and a curl -I https://link... brings up a 200. Since this PR is not introducing any new errors, I was hoping we could proceed with review anyway while I explore solutions for ignoring or removing those errors.

@MichaelLueken
Copy link
Collaborator

@MichaelLueken Currently, the make linkcheck command highlights 2 "broken" links, both from Intel. These links work in the browser, and a curl -I https://link... brings up a 200. Since this PR is not introducing any new errors, I was hoping we could proceed with review anyway while I explore solutions for ignoring or removing those errors.

@gspetro-NOAA - Sure, we can go ahead and proceed with reviewing the current documentation changes while you look into the make linkcheck issues. Once the necessary approvals are received, I will hold off on merging until you give the go ahead.

@gspetro-NOAA gspetro-NOAA added the documentation Improvements or additions to documentation label Feb 12, 2024
Copy link
Collaborator

@RatkoVasic-NOAA RatkoVasic-NOAA left a comment

Choose a reason for hiding this comment

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

Looks good to me. Links work.

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 - These changes look good! I was also able to test the links, which work without issue.

@gspetro-NOAA
Copy link
Collaborator Author

@MichaelLueken I found a solution for the link issue using linkcheck_ignore in the conf.py file, so now make linkcheck should return no errors! :)

@MichaelLueken
Copy link
Collaborator

@MichaelLueken I found a solution for the link issue using linkcheck_ignore in the conf.py file, so now make linkcheck should return no errors! :)

@gspetro-NOAA - Nice! I'll go ahead and get this PR merged in the morning, then we can work on PR #1018.

@MichaelLueken MichaelLueken merged commit 858b551 into ufs-community:develop Feb 15, 2024
2 checks passed
@gspetro-NOAA gspetro-NOAA deleted the text/us-25 branch September 26, 2024 20:56
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.

Quarterly documentation update (PI11)
3 participants