Skip to content

feat: actualize README template #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 9, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .pre-commit-config.yaml

This file was deleted.

17 changes: 17 additions & 0 deletions .terraform-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 0.19.0
formatter: markdown table

recursive:
enabled: true
include-main: false

settings:
lockfile: false

output:
file: README.md
mode: inject
template: |-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
{{ .Content }}
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
1 change: 1 addition & 0 deletions .trunk/trunk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ lint:
- CHANGELOG.md
actions:
enabled:
- terraform-docs
- trunk-announce
- trunk-check-pre-push
- trunk-fmt-pre-commit
Expand Down
76 changes: 58 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,83 @@
[![Banner][banner-image]](https://masterpoint.io/)

# terraform-module-template

[![Release](https://img.shields.io/github/release/masterpointio/terraform-module-template.svg)](https://github.com/masterpointio/terraform-module-template/releases/latest)
[![Release][release-badge]][latest-release]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if we should include something like this so we can push people down below past the docs + get them to read the good stuff down there? What do you think?

Suggested change
[![Release][release-badge]][latest-release]
[![Release][release-badge]][latest-release]
[Learn more about Masterpoint below](#who-we-are)


[💡 Learn more about Masterpoint below](#who-we-are-𐦂𖨆𐀪𖠋)

## Purpose and Functionality

This repository serves as a template for creating Terraform modules, providing a standardized structure and essential files for efficient module development. It's designed to ensure consistency and best practices across Terraform projects.
This repository serves as a template for creating Terraform modules, providing a standardized structure and essential files for efficient module development. It's designed to ensure consistency and our best practices across Terraform projects.

## Usage

### Prerequisites (optional)

TODO

### Step-by-Step Instructions

TODO

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

## Requirements
## Built By

No requirements.
Powered by the [Masterpoint team](https://masterpoint.io/who-we-are/) and driven forward by contributions from the community ❤️

## Providers
[![Contributors][contributors-image]][contributors-url]

No provider.
## Contribution Guidelines

## Inputs
Contributions are welcome and appreciated!

No input.
Found an issue or want to request a feature? [Open an issue][issues-url]

## Outputs
Want to fix a bug you found or add some functionality? Fork, clone, commit, push, and PR — we'll check it out.

No output.
## Who We Are 𐦂𖨆𐀪𖠋

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Established in 2016, Masterpoint is a team of experienced software and platform engineers specializing in Infrastructure as Code (IaC). We provide expert guidance to organizations of all sizes, helping them leverage the latest IaC practices to accelerate their engineering teams.

## Contributing
### Our Mission

Contributions are welcome and appreciated!
Our mission is to simplify cloud infrastructure so developers can innovate faster, safer, and with greater confidence. By open-sourcing tools and modules that we use internally, we aim to contribute back to the community, promoting consistency, quality, and security.

Found an issue or want to request a feature? [Open an issue](TODO)
### Our Commitments
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's push socials!

Suggested change
### Our Commitments
### Connect With Us
We're active members of the community and are always publishing content, giving talks, and sharing our hard earned expertise. Here are a few ways you can see what we're up to:
- 🤝 [Follow us on LinkedIn](https://www.linkedin.com/company/masterpoint-consulting) and be sure to connect with our founder, [Matt Gowie](https://www.linkedin.com/in/gowiem/).
- 👩‍💻 [Check out our blog that is packed full of good content on how to build IaC sustainably](https://masterpoint.io/updates/).
- 🗞️ [Subscribe to our newsletter or read past posts -- all of which are focused on IaC](https://newsletter.masterpoint.io/).
- 📺 [Check us out on YouTube](https://www.youtube.com/@MasterpointConsulting).
### Our Commitments


Want to fix a bug you found or add some functionality? Fork, clone, commit, push, and PR and we'll check it out.
- 🌟 **Open Source**: We live and breathe open source, contributing to and maintaining hundreds of projects across multiple organizations.
- 🌎 **1% for the Planet**: Demonstrating our commitment to environmental sustainability, we are proud members of [1% for the Planet](https://www.onepercentfortheplanet.org), pledging to donate 1% of our annual sales to environmental nonprofits.
- 🇺🇦 **1% Towards Ukraine**: With team members and friends affected by the ongoing [Russo-Ukrainian war](https://en.wikipedia.org/wiki/Russo-Ukrainian_War), we donate 1% of our annual revenue to invasion relief efforts, supporting organizations providing aid to those in need. [Here's how you can help Ukraine with just a few clicks](https://masterpoint.io/updates/supporting-ukraine/).

If you have any issues or are waiting a long time for a PR to get merged then feel free to ping us at [[email protected]](mailto:[email protected]).
## Connect With Us

## Built By
We're active members of the community and are always publishing content, giving talks, and sharing our hard earned expertise. Here are a few ways you can see what we're up to:

- 🤝 [Follow us on LinkedIn](https://www.linkedin.com/company/masterpoint-consulting) and be sure to connect with our founder, [Matt Gowie](https://www.linkedin.com/in/gowiem/).
- 👩‍💻 [Check out our blog that is packed full of good content on how to build IaC sustainably](https://masterpoint.io/updates/).
- 🗞️ [Subscribe to our newsletter or read past posts -- all of which are focused on IaC](https://newsletter.masterpoint.io/).
- 📺 [Check us out on YouTube](https://www.youtube.com/@MasterpointConsulting).

## License

[Apache License, Version 2.0][license-url]. See [LICENSE](./LICENSE) for details.

[![Open Source Initiative][osi-image]][license-url]

Copyright © 2016-2025 [Masterpoint Consulting LLC](https://masterpoint.io/)

<!-- MARKDOWN LINKS & IMAGES -->

[banner-image]: https://masterpoint-public.s3.us-west-2.amazonaws.com/v2/standard-long-fullcolor.png
[license-url]: https://opensource.org/license/apache-2-0
[osi-image]: https://i0.wp.com/opensource.org/wp-content/uploads/2023/03/cropped-OSI-horizontal-large.png?fit=250%2C229&ssl=1

<!-- TODO: Replace `terraform-module-template` with your actual repository name. -->

[![Masterpoint Logo](https://i.imgur.com/RDLnuQO.png)](https://masterpoint.io)
[release-badge]: https://img.shields.io/github/release/masterpointio/terraform-module-template.svg
[latest-release]: https://github.com/masterpointio/terraform-module-template/releases/latest
[contributors-image]: https://contrib.rocks/image?repo=masterpointio/terraform-module-template
[contributors-url]: https://github.com/masterpointio/terraform-module-template/graphs/contributors
[issues-url]: https://github.com/masterpointio/terraform-module-template/issues
2 changes: 1 addition & 1 deletion aqua.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ registries:
- type: standard
ref: v4.210.0 # renovate: depName=aquaproj/aqua-registry
packages:
- name: terraform-docs/terraform-docs@v0.18.0
- name: terraform-docs/terraform-docs@v0.19.0
- name: hashicorp/[email protected]
- name: opentofu/[email protected]