empowerai / fs-permit-platform

Module for intake of special use applications for Forest Service Application Permits

Other

3 stars 0 forks source link

As a potential code contributor, I would like an organized README.md #541

Open lauraGgit opened 6 years ago

lauraGgit commented 6 years ago

Notes

Acceptance Criteria

[x] developers can understand and find relevant information in the README

Tasks

[x] Include a table of contents. (seth)
[x] content audit and reorg of the readme (remove stale info) (seth)
[x] move wiki stuff to the wiki (seth)
[x] TTS approval

Definition of Done

[x] Code unit / e2e tested and comply with QWASP
[x] No new security vulnerabilities
[x] Internal team code review
[x] Documentation / readme.md / CircleCI updated
[x] Docker updated
[x] Compare finished design with mockup
[ ] Usability tested

sethalt commented 6 years ago

Readme has been updated! Much of the instructional text has been moved to markdown files in the wiki with references from the readme. Please review @lauraGgit @JaneZC @MelissaBraxton

lauraGgit commented 6 years ago

[x] This is no longer just the intake module so recommend updating the title
[x] Move the Public Domain block to the end of the readme
[x] Start with and introduction to local development that links to the docker
[x] Update the requirements section ( node version is out of date) - and specify whether these are for local development or deployment
[x] Convert https://github.com/nciinc/fs-permit-platform#available-commands into a table
[x] Move the SMTP relay section into the server section
[x] Let's create a "deployment section"section that references the CircleCi 2.0 wiki page and has mentions the continuous deployment to cloud.gov defined in .cg-deploy

sethalt commented 6 years ago

@lauraGgit @MelissaBraxton i've made the updates to the readme. Bryan is going to tackle the organizing of the mockups into subfolders by page. @bryanmcfadden suggested that it could be a larger task and perhaps we should move it into it's own story.

sadlerw commented 6 years ago

592 handles the reorg of the deliverables. That task can be removed from this story

MelissaBraxton commented 6 years ago

Per Will's suggestion, I removed that task.

sadlerw commented 6 years ago

ok I'm moving this over to on staging then - thanks @MelissaBraxton