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

README Files - create consistent template for use cases #254

Closed
georgemccabe opened this issue Jul 10, 2019 · 3 comments
Closed

README Files - create consistent template for use cases #254

georgemccabe opened this issue Jul 10, 2019 · 3 comments
Assignees
Labels

Comments

@georgemccabe
Copy link
Collaborator

georgemccabe commented Jul 10, 2019

Add README files for each use case directory.
Suggest the following layout:
parm/use_cases/README contains a description of settings common to multiple use cases.
parm/use_cases/*/README contains a description of settings specific to that use case.
The README's will automatically be included into the METplus user's guide in Sphinx. So we need a template for them to ensure consistency. And perhaps they'll need to be in .rst format?
This change was requested by the UKMO to increase ease of use.

@DanielAdriaansen
Copy link
Contributor

#238 also has references to README corrections that may be able to be resolved with this issue.

@JohnHalleyGotway
Copy link
Collaborator

Discussed this during the METplus meeting on 7/15/2019. We redefined this task by splitting out the "updating" portion into #262. Moved this issue from METplus-2.2 to METplus-3.0 since we should coordinate it with development of the user's guide.

@JohnHalleyGotway JohnHalleyGotway changed the title README Files - add missing and update existing README Files - add missing, reorganize, and make consistent across use cases Jul 15, 2019
@JohnHalleyGotway JohnHalleyGotway added priority: blocker Blocker and removed priority: medium Medium Priority labels Jul 15, 2019
@JohnHalleyGotway JohnHalleyGotway changed the title README Files - add missing, reorganize, and make consistent across use cases README Files - create consistent template for use cases Jul 15, 2019
@DanielAdriaansen
Copy link
Contributor

A template for documenting use cases can be found in the METplus repository here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants