Update Contributor's Guide for new removing/adding data protocols #1227
Labels
alert: NEED ACCOUNT KEY
Need to assign an account key to this issue
component: documentation
Documentation issue
priority: high
High Priority
requestor: METplus Team
METplus Development Team
required: FOR OFFICIAL RELEASE
Required to be completed in the official release for the assigned milestone
type: task
An actionable item of work
Milestone
Describe the Task
Two of the most recent issues I've worked on (#1200 and #1187) have revealed a need to revisit the Contributor's Guide and update the sections pertaining to adding data on Mohawk. When the guide was written, it was a largely solo endeavor and focused on the scenario of adding a use case. However, there needs to be information on the scenarios for when use cases change names,and when data is removed/updated for an existing use case.
This will require a "choose your own adventure" style writing, with care taken so it's A) understandable and B) users don't accidentally remove necessary data from the server.
Time Estimate
1-2 days
Sub-Issues
Consider breaking the task down into sub-issues.
Relevant Deadlines
List relevant project deadlines here or state NONE.
Funding Source
Define the source of funding and account keys here or state 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) and Linked issues
Select: Repository level development cycle Project for the next official release
Select: Milestone as the next official version
The text was updated successfully, but these errors were encountered: