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.

Sign up for GitHub

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

Jump to bottom

Review and update new RTD documentation #1272

Closed
KateFriedman-NOAA opened this issue Jan 23, 2023 · 0 comments · Fixed by #1287
Closed

Review and update new RTD documentation #1272

KateFriedman-NOAA opened this issue Jan 23, 2023 · 0 comments · Fixed by #1287
Assignees
@KateFriedman-NOAA
Labels
maintenance Regular updates and maintenance work
Milestone
GW February 2023

Comments

@KateFriedman-NOAA
Copy link
Member

KateFriedman-NOAA commented Jan 23, 2023 •
edited by aerorahul
Loading

Description

The current contents of the global-workflow wiki have been transferred into the new Read-The-Docs documentation as-is and deployed into global-workflow develop @ 6713eae:

https://global-workflow.readthedocs.io/en/latest/index.html

Review the documentation, correct any errors, and update the content for recent system changes.

Once done, repurpose repo wiki.

Related to issue #9.
Closes #9
@KateFriedman-NOAA KateFriedman-NOAA added the maintenance Regular updates and maintenance work label Jan 23, 2023
@KateFriedman-NOAA KateFriedman-NOAA self-assigned this Jan 23, 2023
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 23, 2023
@KateFriedman-NOAA
Correct and update documentation
e406b71 
- 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
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 23, 2023
@KateFriedman-NOAA
Add note blocks
5d39ba6 
- Replace "Note" comments with ".. note::" blocks.

Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 23, 2023
@KateFriedman-NOAA
Convert tables in setup.rst
f1a048f 
- Change table syntax to sphinx syntax.
- Remove extra line in index.rst.

Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 23, 2023
@KateFriedman-NOAA
Update table syntax in setup.rst
b92f984 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Update setup table syntax
996ff68 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Adjust setup table syntax again
57fb3cf 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Adjust setup table syntax yet again
4443217 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Adjust setup table syntax once again
6ab35db 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Trying different syntax for setup table
8dfb565 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Adjust setup table syntax yet again again
744c7f8 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Adjust setup table syntax once again again
1f6a536 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Adjust setup table syntax
e4b8454 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Several RTD documentation updates
b7fb93a 
- 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
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Update setup script examples
af4361f 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Few updates to RTD documentation
8b73765 
- Update setup script name in configure.rst.
- Update python missing error text in errors_faq.rst.

Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Add development tools section
5ec526a 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Fix case in new development section
df57a43 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Fix syntax in new development section
215173a 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Retrying list table format with code in setup
4ca448c 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Update code block in setup table
184ad0f 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Update setup tables to list format
f793d22 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 24, 2023
@KateFriedman-NOAA
Correct rocoto table in setup
fa0d200 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 27, 2023
@KateFriedman-NOAA
Update initial condition documentation
80ca5e6 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 27, 2023
@KateFriedman-NOAA
Small updates to init document
3a1f56c 
Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 27, 2023
@KateFriedman-NOAA
Small corrections to init document
24ed3df 
Refs NOAA-EMC#1272
@KateFriedman-NOAA KateFriedman-NOAA mentioned this issue Jan 27, 2023
Merged
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 27, 2023
@KateFriedman-NOAA
Update table header in components
dea2866 
Refs NOAA-EMC#1272
@KateFriedman-NOAA KateFriedman-NOAA added this to the GW February 2023 milestone Jan 31, 2023
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 31, 2023
@KateFriedman-NOAA
Update clone method section in clone.rst
75f1942 
- Move ssh method above https and mention that ssh method
is highly preferred.

Refs NOAA-EMC#1272
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 31, 2023
@KateFriedman-NOAA
Remove DO_WAVE from configure table
3f9b701 
- 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
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this issue Jan 31, 2023
@KateFriedman-NOAA
Add note 3 to rocoto viewer section
6be2182 
- 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
KateFriedman-NOAA added a commit that referenced this issue Jan 31, 2023
@KateFriedman-NOAA
Updates to RTD documentation based on full review (#1287)
3cbca7d 
Reviewed documentation to correct spelling mistakes and update contents for current state of system.

Refs #1272
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@KateFriedman-NOAA KateFriedman-NOAA

Labels
maintenance Regular updates and maintenance work
Projects
None yet
Milestone
GW February 2023
Development

Successfully merging a pull request may close this issue.

Updates to RTD documentation based on full review KateFriedman-NOAA/global-workflow
1 participant
@KateFriedman-NOAA