New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MVP1 - Update README and create a docs section #65

Closed

facundovictor opened this issue Oct 11, 2018 · 1 comment

Assignees

Labels

Projects

Milestone

Contributor

facundovictor commented Oct 11, 2018 •

edited

Loading

We should:

Create a docs folder to contain specific documentation, with categories like:

General capsule cli explanation
Cloudformation templates explanation including the architecture graph
AWS credentials setup, suggestions and links to useful AWS docs.
Explanation for capsule config
Contribution section:
- how to create issues
- how to creat prs
- how to setup the dev env
- how to test changes
- how to release next version
- "thanks to"
- others?
FAQs

Update README to be the main project presentation and reference docs in under docs/ folder.
Add badges for:

codebuild test passing,
npm version
download count
license fossa scan

facundovictor added the enhancement label

rpigu-i changed the title ~~Update README and create a docs section~~ MVP1 - Update README and create a docs section

rpigu-i self-assigned this

rpigu-i added this to the v1 milestone

rpigu-i added this to To do in Capsule via automation

Collaborator

rpigu-i commented Oct 22, 2019

Badges have been added along with the other items listed in here.

Going to close this out

rpigu-i closed this as completed

Capsule automation moved this from To do to Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment