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.

Sign up for GitHub

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

Jump to bottom

docs: add CDKTF documentation for ec2_* resources/datasource and update script #31596

Merged
merged 7 commits into from
Jun 7, 2023
Merged

docs: add CDKTF documentation for ec2_* resources/datasource and update script #31596

merged 7 commits into from
Jun 7, 2023

Conversation

DanielMSchmidt
Copy link
Contributor

@DanielMSchmidt DanielMSchmidt commented May 26, 2023 •
edited
Loading

Description

This PR introduces CDKTF documentation generated from the original HCL-based documentation. The internal tool doing the conversion replaces the code blocks with the CDKTF equivalent of the HCL. If the HCL is invalid we can not translate it, therefore we keep it as is. We also add a comment with a cache key to each generated document to avoid regenerating them if neither the input nor the used cdktf version changed.

For now we only add documentation for Typescript and Python and only for resources or data sources that start with ec2_.
Once this is merged more PRs for other resources will follow.

The included GitHub action will run every Wednesday night to create a PR with any documentation updates.

@github-actions
Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added size/XL Managed by automation to categorize the size of a PR. documentation Introduces or discusses updates to documentation. github_actions Pull requests that update Github_actions code repository Repository modifications; GitHub Actions, developer docs, issue templates, codeowners, changelog. service/ec2 Issues and PRs that pertain to the ec2 service. service/ec2outposts Issues and PRs that pertain to the ec2outposts service. service/transitgateway Issues and PRs that pertain to the transitgateway service. service/vpc Issues and PRs that pertain to the vpc service. service/vpnclient Issues and PRs that pertain to the vpnclient service. service/wavelength Issues and PRs that pertain to the wavelength service. needs-triage Waiting for first response or review from a maintainer. labels May 26, 2023
github-actions[bot]
github-actions bot reviewed May 26, 2023
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome @DanielMSchmidt 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTOR guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

@ewbankkit
Copy link
Contributor

The tfproviderdocs error requires bflad/tfproviderdocs#50 to fix.

@bflad
Copy link
Contributor

bflad commented May 31, 2023

tfproviderdocs v0.10.0 introduces some initial CDKTF support. Please reach out with any issues.

@github-actions github-actions bot added the linter Pertains to changes to or issues with the various linters. label May 31, 2023
@ewbankkit ewbankkit removed the needs-triage Waiting for first response or review from a maintainer. label Jun 1, 2023
@DanielMSchmidt DanielMSchmidt mentioned this pull request Jun 5, 2023
Merged
xiehan
xiehan suggested changes Jun 5, 2023
View reviewed changes
.github/workflows/cdktf-documentation.yml Outdated Show resolved Hide resolved
breathingdust
breathingdust approved these changes Jun 7, 2023
View reviewed changes
Copy link
Member

@breathingdust breathingdust left a comment

Choose a reason for hiding this comment

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

LGTM @DanielMSchmidt 🚀 Let's see how the job generation goes this evening!

@breathingdust breathingdust merged commit 6e76f1a into hashicorp:main Jun 7, 2023
@github-actions github-actions bot added this to the v5.2.0 milestone Jun 7, 2023
kavan-aws pushed a commit to kavan-aws/terraform-provider-aws that referenced this pull request Jun 7, 2023
@DanielMSchmidt @kavan-aws
docs: add CDKTF documentation for ec2_* resources/datasource and up…
d964108 
…date script (hashicorp#31596)

* chore: add PR based workflow for cdktf docs

* docs: update cdktf documentation

* chore: update dependencies

* chore: add ignore flag

* chore: pin github action versions

* chore: run go mod tidy

* chore: don't use version detection anymore
jar-b added a commit that referenced this pull request Jun 8, 2023
@kavan-aws @DanielMSchmidt @jar-b
[New Resource]: aws_finspace_kx_user (#31804)
e37e301 
* Adds finspace_kx_user resource

* Ran make servicepackages

* Formatting changes for kx user

* Formatting fixes for user tests and docs

* Adds finspace_kx_user resource

* Ran make servicepackages

* Formatting changes for kx user

* docs: add CDKTF documentation for `ec2_*` resources/datasource and update script (#31596)

* chore: add PR based workflow for cdktf docs

* docs: update cdktf documentation

* chore: update dependencies

* chore: add ignore flag

* chore: pin github action versions

* chore: run go mod tidy

* chore: don't use version detection anymore

* Formatting fixes for user tests and docs

* Update kx_user_test.go

* Update kx_user_test.go

* r/aws_finspace_kx_user(docs): terrafmt

* r/aws_finspace_kx_user: alphabetize attributes

* r/aws_finspace_kx_user: crud handlers return diags

* r/aws_finspace_kx_user: find by id to support import

* r/aws_finspace_kx_user: simplify update

* Update finspace_kx_user.html.markdown

* r/aws_finspace_kx_user(docs): use standard tags/tags_all descriptions

* r/aws_finspace_kx_user: import support

* r/aws_finspace_kx_user(test): pass ctx to check funcs

* chore: changelog

* r/aws_finspace_kx_user(test): add base config

* r/aws_finspace_kx_user(docs): fix import resource name

---------

Co-authored-by: Daniel Schmidt <[email protected]>
Co-authored-by: Jared Baker <[email protected]>
@github-actions
Copy link

github-actions bot commented Jun 9, 2023

This functionality has been released in v5.2.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

This was referenced Jun 14, 2023
Merged
Merged
@github-actions
Copy link

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 have 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 Jul 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@xiehan xiehan xiehan requested changes

@breathingdust breathingdust breathingdust approved these changes

Assignees
No one assigned
Labels
documentation Introduces or discusses updates to documentation. github_actions Pull requests that update Github_actions code linter Pertains to changes to or issues with the various linters. repository Repository modifications; GitHub Actions, developer docs, issue templates, codeowners, changelog. service/ec2outposts Issues and PRs that pertain to the ec2outposts service. service/ec2 Issues and PRs that pertain to the ec2 service. service/transitgateway Issues and PRs that pertain to the transitgateway service. service/vpc Issues and PRs that pertain to the vpc service. service/vpnclient Issues and PRs that pertain to the vpnclient service. service/wavelength Issues and PRs that pertain to the wavelength service. size/XL Managed by automation to categorize the size of a PR.
Projects
None yet
Milestone
v5.2.0
Development

Successfully merging this pull request may close these issues.
5 participants
@DanielMSchmidt @ewbankkit @bflad @breathingdust @xiehan