Documentation for Conventions for organizing iidy

unbounce / iidy

iidy (Is it done yet?) -- CloudFormation with Confidence

MIT License

52 stars 7 forks source link

Documentation for Conventions for organizing iidy #98

Open rymndhng opened 6 years ago

rymndhng commented 6 years ago

Given all the features in iidy, it'd be good to have a succinct document that highlights the conventions to recommend users of iidy:

Some things I can think of:

naming of stack-args file name(stack-args.yml, stack-args.yaml)
how to make stack-args.yml reusable
- making use of -e or for multi-environment setups
conventions for working with Templates (i.e. name them some-resource-template.yaml)

tavisrudd commented 6 years ago

The examples/ folder shows some basic conventions. We should add some examples that demonstrate the environments functionality and improve the README docs for that.