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

Move README and README_TC contents to Sphinx #1474

Closed
6 of 7 tasks
jprestop opened this issue Aug 25, 2020 · 4 comments · Fixed by #1582
Closed
6 of 7 tasks

Move README and README_TC contents to Sphinx #1474

jprestop opened this issue Aug 25, 2020 · 4 comments · Fixed by #1582
Assignees
Labels
component: documentation Documentation issue reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: NCAR/RAL NCAR Research Applications Laboratory type: sub-issue Break an issue down into smaller parts type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Aug 25, 2020

This is a sub-issue of #1455

Describe the Sub-Issue

We currently have lots of details about the MET config file formatting and options that live in the data/config/README file (https://github.com/dtcenter/MET/blob/master_v9.1/met/data/config/README).

This README originated back when the MET User's Guide was a Word doc that lived on Tressa's machine and the engineers could not easily/reliably update it with the many, many config file details. In addition, a text file is easier to read/search than a Word doc on a Linux system.

And that README remained through the transition to Lyx since the Lyx files were also not very human-readable.

Now that we've transitioned to Sphinx with .rst files, it seems both reasons for that README file have now disappeared. Engineers can easily update the ascii content in .rst files and .rst files are very human-readable on Linux machines.

We are currently do a literal include of these README files in data_io.rst. But that results in somewhat clunky formatting and we can't reference specific lines directly. Migrate the content of data/config/README and data/config/README_TC into new files in the docs/Users_Guide directory and replace data/config/README with a sentence pointing users to the new location.

Rename README.rst and README_TC.rst to config_options.rst and config_options_tc.rst, then delete section 3.5.1 and 3.5.2 and then have Chapter 4 = "Configuration File Overview" and Chapter 5 = "Tropical Cyclone Configuration Options".

Time Estimate

1 to 3 days of work.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required (Julie Prestopnik)
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Review projects and select relevant Repository and Organization ones
  • Select milestone
@jprestop jprestop added component: documentation Documentation issue type: task An actionable item of work priority: high requestor: NCAR/RAL NCAR Research Applications Laboratory alert: NEED ACCOUNT KEY Need to assign an account key to this issue type: sub-issue Break an issue down into smaller parts labels Aug 25, 2020
@jprestop jprestop added this to the MET 10.0 milestone Aug 25, 2020
@jprestop jprestop added this to To do in MET-10.0.0-beta1 (10/22/20) via automation Aug 25, 2020
@jprestop jprestop self-assigned this Aug 25, 2020
@jprestop jprestop removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Aug 25, 2020
@JohnHalleyGotway JohnHalleyGotway added the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Sep 10, 2020
@TaraJensen TaraJensen added this to To do in MET-10.0.0-beta1 (10/22/20) via automation Sep 15, 2020
@TaraJensen TaraJensen removed the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Sep 15, 2020
@jprestop jprestop added this to To do in MET-10.0.0-beta2 (12/7/20) via automation Oct 13, 2020
@JohnHalleyGotway
Copy link
Collaborator

Many of the default MET config files in met/data/config have a line at the top similar to the following:

// For additional information, see the MET_BASE/config/README file.

or

// For additional information, see the MET_BASE/config/README_TC file.

After README and README_TC are moved to the User's Guide, please replace these comments with a link to the right chapter of the User's Guide.

@jprestop
Copy link
Collaborator Author

jprestop commented Nov 6, 2020

Thanks, John. I forgot about this before approving the pull request. I'll go back in and do those shortly.

@jprestop
Copy link
Collaborator Author

jprestop commented Nov 9, 2020

Will need to remove references to README_TC from met/data/config/Makefile.am. Also, remember to replace the comments in the default MET config files in met/data/config to add links to the README and README_TC files before the next pull request.

@jprestop jprestop moved this from To do to In progress in MET-10.0.0-beta2 (12/7/20) Nov 10, 2020
@jprestop jprestop linked a pull request Nov 20, 2020 that will close this issue
8 tasks
@jprestop
Copy link
Collaborator Author

A pull request was submitted and merged into develop. Closing issue.

MET-10.0.0-beta2 (12/7/20) automation moved this from In progress to Done Nov 30, 2020
@TaraJensen TaraJensen added the reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project label Dec 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: NCAR/RAL NCAR Research Applications Laboratory type: sub-issue Break an issue down into smaller parts type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

4 participants