Skip to content

Documentation: Update links in Verification Datasets Guide #2584

@georgemccabe

Description

@georgemccabe

The links to METplus Use Cases need to be updated. Some of them have an incorrect label, e.g. VxData instead of VxDataMADIS for MADIS. Links that have the correct keyword for a dataset also include the keyword 'UseCase' which finds the same, unrelated use case for every search. It also appears that the VxData* keywords are not actually included in any METplus use case documentation files.

Describe the Task

  • Remove 'UseCase' from the search URLs
  • Review the links in each dataset and ensure that the correct VxDataX label is used in the search
  • Determine which use cases should include the VxDataX labels
  • Change links to use case search to use a relative path instead of hard-coding develop so they navigate to the corresponding branch/tag content
  • Review other content for consistency and accuracy

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

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

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

Labels

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

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions