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

[Docs page] Variables #986

Closed
schersh opened this issue Sep 9, 2021 · 3 comments
Closed

[Docs page] Variables #986

schersh opened this issue Sep 9, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@schersh
Copy link
Contributor

schersh commented Sep 9, 2021

Description
The purpose of this document is to explain to a user who has never used CDK for Terraform or Terraform what variables are, the role they play in infrastructure management, and how to think about using them to manage infrastructure with CDK for Terraform.

Content should go in: /website/docs/cdktf/fundamentals/variables.html.md

This document has several sections. Engineering support is required for the following:

  • Review existing content (already on the page) for accuracy
  • Help author conceptual content about what variables are, how they are used by Terraform, and how they are used and managed by CDK for Terraform. Laura has written a draft of this, but it needs engineering review.
  • Respond to a couple of TODOs - Can we get a description above the example? Can we also help explain to users what's going to happen when the example gets synthesized? Does it create the tfvars file?

Migrate existing https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/terraform-variables.md - DONE

@schersh schersh added the documentation Improvements or additions to documentation label Sep 9, 2021
@laurapacilio
Copy link
Contributor

I have:

  • Transferred content from the original outputs GitHub page
  • Copyedited the content
  • Added more conceptual information at the beginning
  • Added some TODOs on the page that need engineering attention

Once engineering reviews the content and makes any necessary additions, I will review/copyedit again and we can mark this ready for publishing.

@schersh
Copy link
Contributor Author

schersh commented Sep 27, 2021

Closed in favor of #987

@schersh schersh closed this as completed Sep 27, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2022

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants