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

chore(docs): Edits to Project Setup & Config file docs #1085

Merged
merged 9 commits into from
Sep 29, 2021

Conversation

schersh
Copy link
Contributor

@schersh schersh commented Sep 27, 2021

This PR presents edits for /project-setup and /cdktf-json documentation files.

Note: In the cdktf.json file, there is still a TODO listed under ### Version Constraint to add an example.

Related to issue #975 and #1056

@schersh schersh added the documentation Improvements or additions to documentation label Sep 27, 2021
@hashicorp-cla
Copy link

hashicorp-cla commented Sep 27, 2021

CLA assistant check
All committers have signed the CLA.

@schersh schersh changed the title Sm/975 edit Edits to Project Setup & Config file docs Sep 27, 2021
@schersh
Copy link
Contributor Author

schersh commented Sep 27, 2021

Looks like I have some prettier errors, will resolve tomorrow.

Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

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

This is AWESOME, Sarah! I left a few suggestions that you can take or leave. But thank you it's great!

website/docs/cdktf/concepts/fundamentals/cdktf-json.md Outdated Show resolved Hide resolved
website/docs/cdktf/concepts/fundamentals/cdktf-json.md Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.html.md Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.html.md Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.html.md Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.html.md Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.html.md Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.html.md Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.html.md Outdated Show resolved Hide resolved
@schersh schersh changed the title Edits to Project Setup & Config file docs [chore] Edits to Project Setup & Config file docs Sep 28, 2021
schersh and others added 6 commits September 28, 2021 11:41
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
@schersh
Copy link
Contributor Author

schersh commented Sep 28, 2021

@skorfmann this is ready for your review, thanks!

@schersh schersh changed the title [chore] Edits to Project Setup & Config file docs chore (docs) Edits to Project Setup & Config file docs Sep 28, 2021
@schersh schersh changed the title chore (docs) Edits to Project Setup & Config file docs chore(docs): Edits to Project Setup & Config file docs Sep 28, 2021
@skorfmann
Copy link
Contributor

Cool, thanks - looks great! Gonna merge and fix issues around linting if there are really any.

@skorfmann skorfmann merged commit 43b0b4c into docs-project-setup-975 Sep 29, 2021
@skorfmann skorfmann deleted the sm/975-edit branch September 29, 2021 13:27
@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2022

I'm going to lock this pull request 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 related to this change, 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 8, 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

Successfully merging this pull request may close these issues.

None yet

4 participants