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 and Outputs #987

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

[Docs page] Variables and Outputs #987

schersh opened this issue Sep 9, 2021 · 8 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 outputs 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/concepts/fundamentals/outputs.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 outputs 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.
  • Can we add a block at the end of the page that shows what this output example looks like when printed for the user? Also, does it look different when it's printed when we deploy through CDKTF vs. when we synthesize and run the configuration from Terraform?
  • Can we also take a minute at the top of the page to explain when folks should consider using Terraform Outputs, rather than just sticking with what's available in their programming language?

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

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

This work is also contingent on whether #227 is built during 0.7

@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 a TODO at the bottom of the page for engineering

Once engineering reviews the content and addresses the TODO, I will review again and we can mark this ready for publishing.

@laurapacilio
Copy link
Contributor

FYI: @skorfmann made an initial PR here: #1078 (comment)
After some discussion with @schersh this morning, I started PR with edits here: #1080

@schersh schersh changed the title [Docs page] Outputs [Docs page] Variables and Outputs Sep 27, 2021
@schersh
Copy link
Contributor Author

schersh commented Sep 27, 2021

Updated to title to reflect more content will be included in this page

This was referenced Sep 27, 2021
@schersh
Copy link
Contributor Author

schersh commented Sep 30, 2021

#1078 is in progress

@DanielMSchmidt
Copy link
Contributor

@schersh Can this be closed since #1078 is merged?

@schersh
Copy link
Contributor Author

schersh commented Dec 1, 2021

Yes, thanks!

@schersh schersh closed this as completed Dec 1, 2021
@github-actions
Copy link
Contributor

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 Nov 30, 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

5 participants