Add descriptions to variables

Open Beginner friendly
#166 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
terraform
Domain
infrastructure

Research direction

Compare the variable declarations in variables.tf with the existing descriptions in terraform.tfvars. Copy each matching description into variables.tf, then run Terraform formatting or validation to confirm the declarations remain valid and all variables are covered.

Written by the indexing model from the issue text.

Description

Background

Typical Terraform pattern is to make use of the description field on variables to give context what they are used for. The terraform.tfvars file seems to have these descriptions already, but not for the variables themselves in variables.tf.

Desired Change

Copy the description of variables from terraform.tfvars to variables.tf.

Dominant language
Python
Stars
1.5k
Forks
178
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from airbnb/binaryalert

All issues in airbnb/binaryalert

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.