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]: Policy update to recommended AWS SDK V2 and Plugin Framework #33595

Merged
merged 26 commits into from
Oct 20, 2023

Conversation

jar-b
Copy link
Member

@jar-b jar-b commented Sep 22, 2023

Description

Updates the contributor documentation to reflect that AWS SDK for Go V2 and Terraform Plugin Framework are now the preferred libraries for use with the provider. This includes stating that all net-new resources and data sources must be implemented with Terraform Plugin Framework, and net-new services must use V2 AWS SDK clients. Code samples have been updated to includes examples with each library/framework, where applicable.

The complete list of pages requiring modification:

  • aws-go-sdk-versions.md
  • terraform-plugin-versions.md
  • add-a-new-datasource.md
  • add-a-new-resource.md
  • add-a-new-service.md
  • data-handling-and-conversion.md
  • error-handling.md
  • resource-filtering.md
  • resource-name-generation.md
  • resource-tagging.md
  • retries-and-waiters.md

To preview a rendered version of the documentation locally, install mkdocs (see updated docs/README.md for instructions) and run:

mkdocs serve

Relations

Relates: #32917

Output from Acceptance Testing

N/a - docs

@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. labels Sep 22, 2023
@terraform-aws-provider terraform-aws-provider bot added the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Sep 22, 2023
@jar-b jar-b force-pushed the d-framework-upgrade branch 3 times, most recently from e2a08bc to bbae5e3 Compare September 25, 2023 18:45
@jar-b jar-b force-pushed the d-framework-upgrade branch 3 times, most recently from a4b9bcf to 76f617e Compare October 18, 2023 18:05
@jar-b jar-b marked this pull request as ready for review October 18, 2023 18:06
@jar-b jar-b changed the title [WIP] [Docs]: Policy update to recommended AWS SDK V2 and Plugin Framework [Docs]: Policy update to recommended AWS SDK V2 and Plugin Framework Oct 18, 2023
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀.

docs/terraform-plugin-versions.md Outdated Show resolved Hide resolved
@jar-b jar-b merged commit daa8946 into main Oct 20, 2023
22 checks passed
@jar-b jar-b deleted the d-framework-upgrade branch October 20, 2023 18:45
@github-actions github-actions bot added this to the v5.23.0 milestone Oct 20, 2023
github-actions bot pushed a commit that referenced this pull request Oct 20, 2023
@github-actions
Copy link

This functionality has been released in v5.23.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!

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 Nov 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. size/XL Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants