Updates to RTD documentation based on full review #1287
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Reviewed documentation to correct spelling mistakes and update contents for current state of system. - Introduced a couple tables where needed. - More updates to come. Refs NOAA-EMC#1272
- Replace "Note" comments with ".. note::" blocks. Refs NOAA-EMC#1272
- Change table syntax to sphinx syntax. - Remove extra line in index.rst. Refs NOAA-EMC#1272
- Update to use header row in tables. - Update configuration table contents. - Update example output from setup commands. - Update warning text for crontab command. Refs NOAA-EMC#1272
- Update setup script name in configure.rst. - Update python missing error text in errors_faq.rst. Refs NOAA-EMC#1272
WalterKolczynski-NOAA
requested changes
Jan 31, 2023
- Move ssh method above https and mention that ssh method is highly preferred. Refs NOAA-EMC#1272
- Since DO_WAVE is controlled by the APP switch don't need to mention DO_WAVE in the switch configuration table. Refs NOAA-EMC#1272
- Note 3 states that TERM=xterm is the only supported TERM. - Include bash example of shell function to automatically switch if user is in different terminal. Refs NOAA-EMC#1272
|
Preview of RTD updated after addressing @WalterKolczynski-NOAA's comments: https://www.emc.ncep.noaa.gov/gmb/emc.glopara/read-the-docs/global-workflow/issue1272/index.html |
WalterKolczynski-NOAA
approved these changes
Jan 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the new RTD documentation that was moved from the global-workflow wiki. The wiki (and now RTD) needed to be reviewed for updates related to recent GFS/global-workflow system updates, as well as fix some spelling/syntax issues. This is the first documentation update since the new RTD documentation was added to the repo.
As part of the updates the following changes occurred:
noteandwarningboxes.Preview of incoming updated documentation can be viewed here on RZDM:
https://www.emc.ncep.noaa.gov/gmb/emc.glopara/read-the-docs/global-workflow/issue1272/index.html
Note: Pages will look a bit different (e.g. missing bullets), likely due to no Sphinx installation on RZDM (?). Expect other similar subtle differences compared to live RTD documentation page. I'm open to suggestions to make this preview look more like the live pages (e.g. install Sphinx?).
Type of change
Maintenance and regular updates to documentation.
How Has This Been Tested?
Viewed feature branch Git Action artifact generated html pages in browser.
Resolves #1272