search

18F / data-act-pilot

This small DATA Act pilot contains code that translates agency data to a uniform DATA act format.
Other
21 stars 14 forks source link

documentation upgrade #175

Closed bsweger closed 8 years ago

bsweger commented 8 years ago

I think this is ready to merge: we can make other changes later, if needed

This re-organizes our existing project documentation and adds a few things as we wind down sprints. This PR will ultimately address: #169, #173, and #171.

msecret commented 8 years ago

I like this structure so far.

bsweger commented 8 years ago

@msecret @elainekamlley @emileighoutlaw I moved DEPLOY.md to the new docs/ folder and linked to it from the updated README.. What do you think? Is it more important to keep all the docs in one place, or to keep the deploy instructions in the application folder?

bsweger commented 8 years ago

Added draft of the user how-to instructions: https://github.com/18F/data-act-pilot/blob/doc-reorg/docs/HOWTO.md

@elainekamlley happy to make changes based on your website copy work. @emileighoutlaw this is ready for your eyes!