nimblehq / infrastructure-templates

For IaaS and PaaS as codes
MIT License
10 stars 0 forks source link

Create the wiki for the infrastructure template #200

Closed longnd closed 1 year ago

longnd commented 1 year ago

Why

The infrastructure-template is a useful tool for generating infrastructure code for a new project. However, its documentation is very minimal and lacks instructions on the architecture of the template, how to contribute, and how to use a newly generated project.

This lack of documentation limits contributions from the team, for instance, the recent refactor in the template, as seen in https://github.com/nimblehq/infrastructure-templates/pull/169#issuecomment-1547429319, may be difficult for any team member to understand without any technical documentation.

Who Benefits?

The web chapter & the outside contributors can contribute to the infrastructure-template easier.