-
Notifications
You must be signed in to change notification settings - Fork 37
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
Clean up use case documentation files #681
Comments
From PR #882, we found a few minor edits to apply to the repeated content for each use case. To avoid redundancy, we could move the common content to another file to reference in each use case doc. Suggested changes: Change (Click here to see the METplus releases):
to
Change (parm/metplus_config, then to parm/metplus_config and then):
to
Change (Path where METplus to Path to directory where METplus):
to
|
@georgemccabe I see a note above that says "georgemccabe linked a pull request on May 6, 2021 that will close this issue", but I see that this issue is still Open. Should it be closed? |
@jprestop, no, I don't think that PR completes this work. I think that note was generated because the PR was linked to this issue under "Development." This issue seems related to #918, which @j-opatz is working on. John, could you refer to this issue to ensure that the changes mentioned here are covered in the use case doc template work? |
Thanks for the clarification @georgemccabe. I've been trying to help go through issues with @lisagoodrich to help her find things to work on. |
There are a handful of text that are identical in every use case doc file that should be cleaned up and improved in across the board.
One example is the way we word the "Running METplus" section requires us to modify the name of the new config 4 times. We also have discussed improving how we show how METplus config variables correspond to MET config variables (#402).
Describe the Task
We should clean up the information in these files so it is easier to create a new use case. Things to consider:
Time Estimate
3+ days
Sub-Issues
Consider breaking the task down into sub-issues.
Relevant Deadlines
None
Funding Source
None
Define the Metadata
Assignee
Labels
Projects and Milestone
Define Related Issue(s)
Consider the impact to the other METplus components.
Task Checklist
See the METplus Workflow for details.
Branch name:
feature_<Issue Number>_<Description>
Pull request:
feature <Issue Number> <Description>
Select: Reviewer(s), Project(s), Milestone, and Linked issues
The text was updated successfully, but these errors were encountered: