Create content about using mock data to Vets-API docs

laucon commented 10 months ago

Issue Description

This is continued work from this ticket

Slack support ticket request: https://dsva.slack.com/archives/CBU0KDSB1/p1693432963478369
More info from how the ticket originated: https://dsva.slack.com/archives/CBU0KDSB1/p1693372612482079

Tasks

[x] Review Slack support request started here: https://dsva.slack.com/archives/CBU0KDSB1/p1693432963478369
[x] Reach out to Patrick Vinograd (VA stakeholder) for more direction on how to incorporate content about how to redirect Platform website readers to this github document: https://github.com/department-of-veterans-affairs/vets-api/blob/master/CONTRIBUTING.md
[ ] Run this new content by Peter Hill (from the Platform) for a second set of eyes.
[ ] Make any content edits or create new page, as needed
[ ] Identify where in the IA it should live (probably somewhere under Backend developer docs)
[ ] Prepare documentation for deployment

Idea from Platform support thread: Perhaps it wouldn't hurt to have a page dedicated to introducing the repo, explaining what it's used for, any additional setup, how to add to it, and some of the caveats like what Patrick discussed in that thread. So yes, perhaps we can have a page in backend docs for this, containing the various sections I just mentioned, linking to it anywhere else we mention the mockdata repo, then linking to the README.

Potential Page Structure

Potential Page Title: Working with Mock Data Potential Page Location: Developer Docs Topics to Cover:

How to use the existing mock data,
When you might need to record new mock data
If so, how to do so
What are the limitations of this mechanism of mocking data (i.e. it won't work for very wide-ranging queries like the facilities API).

Reference Github Page

Acceptance Criteria

[ ] Content on the Platform website will exist to introduce and link to this github file: https://github.com/department-of-veterans-affairs/vets-api/blob/master/CONTRIBUTING.md

torrirosine commented 9 months ago

Reached out to Patrick Vinograd 9/20/23 in the Slack thread listed in the body of the ticket for more information. He indicated that there may be some issues trying to create mock data to include on the site due to the variety of requests and the volume of the responses that could be generated. His workload has significantly increased recently and he no longer has availability to assist us with this ticket at this time, possibly in the future.

jknipes commented 2 months ago

Epic changed to Q2 as FY2024 now aligns with calendar year, and this issue is carrying over into the next quarter

jknipes commented 3 weeks ago

I reached out to Patrick Vinograd in the Slack thread to determine availability

jknipes commented 4 days ago

This issue is blocked pending available capacity of SME

department-of-veterans-affairs / va.gov-team