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] Tokens #988

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

[Docs page] Tokens #988

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

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 tokens are and when they should use them when creating CDK for Terraform applications.

Content should go in: /website/docs/cdktf/fundamentals/tokens.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 tokens are, how they are used by CDKTF, and when users should incorporate them into their applications.
  • Address some TODOs (in the markdown)
    • TODO: Should we say something about how you can encode tokens as different types where needed and link back to the AWS docs?
    • TODO: Explain how folks will know when they need to use tokens. Will folks see an error when something isn't translating properly into Terraform language syntax?

Migrate existing content - DONE

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

laurapacilio commented Sep 15, 2021

I have:

  • Transferred content from the original outputs GitHub page
  • Copyedited the content
  • Added more conceptual information at the beginning
  • Significantly reorganized the content. @DanielMSchmidt As I'm new to this, it's possible that in my reorganization, I got some things wrong. Please fix as is needed! My goal is to make things easier to read and give users more context about what tokens are and why they should use them. We can link to the AWS docs, but I don't want to make people go there to understand the concept - I only want them to go there for more detail if they want to. I also removed an example that was on the original docs page - it's one that had to do with modules. I think the point of it was maybe to show that if you don't use tokens, the module output doesn't resolve to the correct type...but I really wasn't sure. And then the extra emphasis on what module outputs was felt a bit confusing, so I removed it. Please add it back if you think it's needed! Also happy to discuss this :-)
  • Added some TODOs into the markdown file that should be addressed by engineering. These are questions I had while reading that I hope we can clarify for users.

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

@DanielMSchmidt
Copy link
Contributor

I looked through it, looks great. I added a new part about number tokens: #1140

@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

4 participants