We encourage you to take a moment to go through the contributing docs before making your first pull request. It’s also highly recommended to look for existing issues and pull requests to avoid duplicating efforts.

If you need any help, feel free to reach out to @casadeporter or open an issue.

​
About this repository

The repository is a collection of Terraform modules that are designed to be used in your infrastructure.

​
Structure

docs
├── contributing
├── images
├── logo
├── modules
└── snippers
modules
└── {type}
    ├── main.tf
    ├──  variables.tf
    ├──  outputs.tf
    ├──  versions.tf
    └── README.md
PathDescription
docsHolds all mintlify doc site related resources.
docs/contributingThe mdx based mintlify docs for contributing.
docs/imagesThe images used on the docs site
docs/logoThe logo used on the docs site.
modules/{type}Holds all Terraform configurations for a modules type (ex. Website or API).
modules/{type}/main.tfThe main terraform file for the module. This holds the resource configuration.
modules/{type}/variables.tfThe variables terraform file for the module. This holds the config variables.
modules/{type}/outputs.tfThe outputs terraform file for the module. This holds the outputs for each main resource created.
modules/{type}/README.mdA readme specifically for the module. It includes generated docs from terraform-docs.

​
Requests for new modules

If you’re interested in proposing a new module, please start a discussion on GitHub.

Was this page helpful?

Development