Comments (9)
@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.
from data-federation-project.
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?
from data-federation-project.
Wiki sounds like a good place.
from data-federation-project.
Some items from the security checklist we need to perform:
- 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
- Provide instructions on how to deploy and re-initialize the application. This will be used as the recovery instruction:
- Deployment Guide:
- Provide instructions on how to deploy the system manually.
from data-federation-project.
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?
from data-federation-project.
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?
from data-federation-project.
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.
from data-federation-project.
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.
from data-federation-project.
Sounds good to me. Let's close this issue.
from data-federation-project.
Related Issues (20)
- Outline Phase 4 pitch HOT 1
- Allow user to include precision in error message with calculation HOT 1
- Scope FNS <> 18F engagement HOT 1
- Set up interviews with at least 3 more federated data case studies HOT 1
- Reach back out to Jon at login to talk about pitch process for FCSF support HOT 2
- Add a JsonSchemaValidator, this will help support validating complex JSON data. HOT 1
- Mike to build [reduce complexity/enhance features] spectrum kinda thing in Mural HOT 1
- Phase 4 Pitch draft HOT 2
- Draft list of anticipated support needs to help FNS put together a PWS HOT 1
- Investigate cloud hosting options for FNS
- Talk to security leads about considerations moving from prototype to production HOT 1
- Put together roadmap from prototype to production for FNS HOT 1
- Establish mailing list for U.S. Data Federation HOT 3
- Workstream 1 synthesis and output HOT 2
- Research follow ups
- Document needs of OFCIO and OFFM HOT 1
- Pin dependencies HOT 1
- Create Content for FNS Developers' Guide HOT 1
- Update project README
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from data-federation-project.