USACE / USACE/cwms-data-api

Create CDA Usage/Data Reference Page

Open
#1,459 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
28
Forks
25
Avg merge
4d 22h
Merged PRs (30d)
20

Description

Is your feature request related to a problem? Please describe.

Public and Internal entities often request data through our water@ email or through internal channels.

CDA is a great resource for this and so are district sites and A2W.

Describe the solution you'd like

In these such requests where a FOIA does not fit exactly I suggest we make a page on CDA we can easily reference options for data retrieval.

We could show links to A2W, discuss plans for authoratative TS, reference when you might do a FOIA over the automated nature of CDA and how it is subject to change.

Perhaps go into programming (CDA) VS more user friendly options like A2W and Data Query Tool.

The goal being we can easily link to this from inquiry both internal and external.

Additional context
A2W could also serve such a page. It also has a data page.
Ie https://water.usace.army.mil/data

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing A2W data page at https://water.usace.army.mil/data and the CDA, district-site, and Data Query Tool options named in the issue. Done means publishing a reference page that explains retrieval options, authoritative TS plans, when FOIA is preferable to automated CDA data, and the difference between programming and user-friendly access.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.