Move README and README_TC contents to Sphinx #1474
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
Milestone
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
Labels
Projects and Milestone
The text was updated successfully, but these errors were encountered: