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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make file name convention list more readable #35315

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cadamini
Copy link
Contributor

@cadamini cadamini commented Jun 9, 2024

Just stumbled over this list while reading. I think the verb doesn't need to be repeated.

Comment on lines +105 to +107
- A `network.tf`: VPC, subnets, load balancers, and all other networking resources.
- A `storage.tf`: Object storage and related permissions configuration.
- A `compute.tf`: Compute instances.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
- A `network.tf`: VPC, subnets, load balancers, and all other networking resources.
- A `storage.tf`: Object storage and related permissions configuration.
- A `compute.tf`: Compute instances.
- A `network.tf`: VPC, subnets, load balancers, and all other networking resources
- A `storage.tf`: Object storage and related permissions configuration
- A `compute.tf`: Compute instances

periods required?

Comment on lines +94 to +101
- `backend.tf`: Your [backend configuration](/terraform/language/settings/backends/configuration). You can define multiple `terraform` blocks in your configuration to separate your backend configuration from your Terraform and provider versioning configuration.
- `main.tf`: Resource and data source blocks.
- `outputs.tf`: Output blocks in alphabetical order.
- `providers.tf`: Your `provider` blocks and configuration.
- `terraform.tf`: A single `terraform` block which defines your `required_version` and `required_providers`.
- `variables.tf`: Variable blocks in alphabetical order.
- `locals.tf`: Local values. Refer to [local values](#local-values) for more information.
- `override.tf`: Override definitions for your configuration. Terraform loads this and all files ending with `_override.tf` last. Use them sparingly and add comments to the original resource definitions, as these overrides make your code harder to reason about. Refer to the [override files](/terraform/language/files/override) documentation for more information.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
- `backend.tf`: Your [backend configuration](/terraform/language/settings/backends/configuration). You can define multiple `terraform` blocks in your configuration to separate your backend configuration from your Terraform and provider versioning configuration.
- `main.tf`: Resource and data source blocks.
- `outputs.tf`: Output blocks in alphabetical order.
- `providers.tf`: Your `provider` blocks and configuration.
- `terraform.tf`: A single `terraform` block which defines your `required_version` and `required_providers`.
- `variables.tf`: Variable blocks in alphabetical order.
- `locals.tf`: Local values. Refer to [local values](#local-values) for more information.
- `override.tf`: Override definitions for your configuration. Terraform loads this and all files ending with `_override.tf` last. Use them sparingly and add comments to the original resource definitions, as these overrides make your code harder to reason about. Refer to the [override files](/terraform/language/files/override) documentation for more information.
- `backend.tf`: Your [backend configuration](/terraform/language/settings/backends/configuration). You can define multiple `terraform` blocks in your configuration to separate your backend configuration from your Terraform and provider versioning configuration.
- `main.tf`: Resource and data source blocks
- `outputs.tf`: Output blocks in alphabetical order
- `providers.tf`: Your `provider` blocks and configuration
- `terraform.tf`: A single `terraform` block which defines your `required_version` and `required_providers`
- `variables.tf`: Variable blocks in alphabetical order
- `locals.tf`: Local values. Refer to [local values](#local-values) for more information.
- `override.tf`: Override definitions for your configuration. Terraform loads this and all files ending with `_override.tf` last. Use them sparingly and add comments to the original resource definitions, as these overrides make your code harder to reason about. Refer to the [override files](/terraform/language/files/override) documentation for more information.

periods required for incomplete sentences?

@cadamini cadamini marked this pull request as ready for review June 9, 2024 00:59
@crw
Copy link
Collaborator

crw commented Jun 10, 2024

Thanks for the submission. Passing to the docs team for review.

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

Successfully merging this pull request may close these issues.

None yet

2 participants