brettwporter/infra

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.

We use Terraform to manage our infrastructure.
We use Mintlify to manage our documentation.
We use Conventional Commits for our commit formats.
We use changesets to manage our releases.

Structure

docs
├── contributing
├── images
├── logo
├── modules
└── snippers
modules
└── {type}
    ├── main.tf
    ├──  variables.tf
    ├──  outputs.tf
    ├──  versions.tf
    └── README.md

Path	Description
`docs`	Holds all mintlify doc site related resources.
`docs/contributing`	The mdx based mintlify docs for contributing.
`docs/images`	The images used on the docs site
`docs/logo`	The logo used on the docs site.
`modules/{type}`	Holds all Terraform configurations for a modules type (ex. Website or API).
`modules/{type}/main.tf`	The main terraform file for the module. This holds the resource configuration.
`modules/{type}/variables.tf`	The variables terraform file for the module. This holds the config variables.
`modules/{type}/outputs.tf`	The outputs terraform file for the module. This holds the outputs for each main resource created.
`modules/{type}/README.md`	A 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.