Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of docs: Terraform style guide into v1.5 #34909

Open
wants to merge 19 commits into
base: v1.5
Choose a base branch
from

Conversation

teamterraform
Copy link
Contributor

Backport

This PR is auto-generated from #34876 to be assessed for backporting due to the inclusion of the label 1.5-backport.

The below text is copied from the body of the original PR.


Note: This PR requires a redirect from the existing style conventions doc. Once this PR is merged, merge hashicorp/terraform-docs-common#584

馃攳 Deploy preview

The Well-Architected Framework team has gathered feedback from HashiCorp employees and Terraform users in an attempt to build on our recommended style contentions. The intention of this guide is that it is used by those looking to form their own internal standardized style guide.

This guide is split into two parts:

  1. Code style: Syntax conventions (brought from the existing style conventions document), resource naming and ordering, linting, variables, outputs, locals, etc.
  2. Workflow style: Versioning, repo structure, module design, state management, secrets management, etc

This guide is a mix of prescriptive advice and non-prescriptive considerations, as some scenarios truly depend on the situation.


Overview of commits

Copy link
Member

@radeksimko radeksimko left a comment

Choose a reason for hiding this comment

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

Nitpick: Would you mind cherry-picking this small fix #34938 here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants