claranet
docs: Stack mixing Azure and AWS S3?
Current README.md in the Stacks configurations shows an example which is described this way:
Here is an example for a stack on Azure configuration using user mode and AWS S3 backend for state storage:
- Is this correct? There seem to be no actual reference to AWS S3.
- Why blending Azure and AWS in single stack configuration?
Looks ok, but assigning @Shr3ps as he did write that example.
https://github.com/claranet/terraform-wrapper/commit/9150f2effa44700b5fe918fade15a7496448db03#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L193
I now see where the confusion came from - sequence of presenting the material which is unexpected to a newbie reader:
The aws-demo displayed in the Stacks configurations section is a reference to AWS S3 storage explained in the later section States centralization configuration.
TBH, a simple self-contained "Getting Started" is missing for those who wish to learn the tool from zero to usable hero. Currently, a new user has to read through the whole README before gaining confidence to fire any initial tfwrapper command.
- Why blending Azure and AWS in single stack configuration?
Just a matter of an organization's policies.
One may want to store its Terraform states in a single centralized location, even in the case of multi-cloud deployments.
One may want to store its Terraform states in a single centralized location, even in the case of multi-cloud deployments.
Yeah, it makes sense now, but such consideration was unexpected at my very initial learning stage here.
TBH, a simple self-contained "Getting Started" is missing for those who wish to learn the tool from zero to usable hero. Currently, a new user has to read through the whole README before gaining confidence to fire any initial
tfwrappercommand.
Agreed!
All those examples should be moved from the README into several self-contained example stacks.
Contributions welcome 🙂
PS: we participate to hacktoberfest
Some say the best way to learn a thing is to write a book about it, but documentation is special and - from my own long-term experience as FOSS contributor and maintainer - hacktoberfest-like events often attracting ad-hoc contributors w/o knowledge necessary to provide quality contributions do not work well for it.