Create outline for FNS Data Validation Service Developers' Guide

18F / data-federation-project

A project focused on tools and best practices to supported federated data collection efforts

28 stars 9 forks source link

Create outline for FNS Data Validation Service Developers' Guide #179

Closed juliaklindpaintner closed 5 years ago

juliaklindpaintner commented 5 years ago

Overview

As a developer supporting the FNS Data Validation Service, I want to know how to deploy and maintain it so that it continue to be used by FNS after the engagement with 18F is over.

Acceptance criteria

[x] Start a doc
[x] Evaluate how much of the Demo Notes to bring in
[x] Establish the sections we should cover in this guide

amymok commented 5 years ago

Some items from the security checklist we need to perform:

[x] Recovery Guide:
- Provide instructions on how to deploy and re-initialize the application. This will be used as the recovery instruction:
- Needs to document what is needed to perform recovery
- There is still a need to re-initiate a database because of django-data-ingest
- Reapply database migration
[x] Deployment Guide:
- Provide instructions on how to deploy the system manually.

mheadd commented 5 years ago

I started to write this up as a separate Google doc, but it didn't seem to make sense given that there is actually a lot of content in the repo that should be included in the guide. So I decided to use the project wiki as a home for this.

https://github.com/18F/usda-fns-ingest/wiki

Thoughts, @amymok, @juliaklindpaintner?

amymok commented 5 years ago

Wiki sounds like a good place.

mheadd commented 5 years ago

So I've incorporated most of our existing content into the wiki in the usda-fns-ingest repo. A couple of outstanding issues to highlight:

The README is probably obsolete, since most of the content is now in the wiki, and it's probably easier to maintain it in one place.
There may be a delta between the api.md doc in the repo, and one that @amymok has been updating in the django-data-ingest repo. Not sure if the difference matters, but if it does we should use the most current version.
There are some other docs in the django-data-ingest repo that I'm wondering if we should incorporate into the wiki. For example, can we use this overview on customization validation in the FNS wiki?

amymok commented 5 years ago

Thank you so much @mheadd . I will definitely try to go over some of those to make updates. I think one thing I have been thinking about as well is, do we actually want to duplicate some of documents from django-data-ingest to here. Or should we just point to them there? It means potentially everything will get outdated here. But if we are locking down a django-data-ingest version, maybe it is better to have the outdated doc lives here because we are using that version here.

Any thoughts?

mheadd commented 5 years ago

@amymok Yeah, if we're locking down a django-data-ingest version for the FNS Data Validator, then maybe it makes sense for there to be a separate copy that is tailored to that version.

juliaklindpaintner commented 5 years ago

Thank you for this work, @mheadd! I agree it makes sense to have the separate copy here for FNS that can also build in more language that is specific to their use case and users.

mheadd commented 5 years ago

FYSA - I checked off the remaining acceptance criteria because I think we've done them. The guide isn't done, but I think we've finished identifying the sections to be included and incorporated as much of our current content as we can at this point.

juliaklindpaintner commented 5 years ago

Sounds good to me. Let's close this issue.