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

Update docs to reflect service packages refactor #21506

Merged
merged 2 commits into from
Oct 27, 2021
Merged

Update docs to reflect service packages refactor #21506

merged 2 commits into from
Oct 27, 2021

Conversation

zhelding
Copy link
Contributor

Community Note

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

Relates #20000, #21306.

Updates docs with a number of small edits to bring in line with service packages refactor introduced by PR #21306.

@github-actions github-actions bot added documentation Introduces or discusses updates to documentation. provider Pertains to the provider itself, rather than any interaction with AWS. size/M Managed by automation to categorize the size of a PR. labels Oct 26, 2021
zhelding
zhelding commented Oct 26, 2021
View reviewed changes
docs/contributing/contribution-checklists.md
- In `aws/internal/keyvaluetags`: Ensure the service is supported by all generators. Run `make gen` after any modifications.
- In `aws/tag_resources.go`: Add the new `//go:generate` call with the correct service name. Run `make gen` after any modifications.
- In `aws/provider.go`: Add the new resource.
- In `internal/generate`: Ensure the service is supported by all generators. Run `make gen` after any modifications.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe these revised steps are accurate? But may need revisiting.

ewbankkit
ewbankkit reviewed Oct 26, 2021
View reviewed changes
docs/contributing/retries-and-waiters.md
@@ -548,4 +548,4 @@ function ExampleThingDelete(d *schema.ResourceData, meta interface{}) error {
}
```

Typically, the AWS Go SDK should include constants for various status field values (e.g., `StatusCreating` for `CREATING`). If not, create them in a file named `aws/internal/service/{SERVICE}/consts.go`.
Typically, the AWS Go SDK should include constants for various status field values (e.g., `StatusCreating` for `CREATING`). If not, create them in a file named `internal/service/{SERVICE}/consts.go`.
Copy link
Contributor

@ewbankkit ewbankkit Oct 26, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Sometimes these are named consts.go, sometimes enum.go. @YakDriver any thoughts around consistency?

Copy link
Member

Choose a reason for hiding this comment

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

"Enumeration" does not accurately reflect the typical usage. The idea behind an enumeration is a list of all the options or possibilities. Usually, we have constants with timeout values or strings for matching errors or whatever but not lists of all possibilities. Thus, consts.go has my vote. Also, developers know exactly what consts has.

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes sense. Can you open an issue to rename existing enum.gos?

ewbankkit
ewbankkit approved these changes Oct 27, 2021
View reviewed changes
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 🚀.

@zhelding zhelding merged commit 901d606 into main Oct 27, 2021
@zhelding zhelding deleted the d-service-packages-docs-edit branch October 27, 2021 22:03
@github-actions github-actions bot added this to the v3.64.0 milestone Oct 27, 2021
@github-actions
Copy link

github-actions bot commented Nov 4, 2021

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

@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 Jun 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@YakDriver YakDriver YakDriver left review comments

@ewbankkit ewbankkit ewbankkit approved these changes

Assignees
No one assigned
Labels
documentation Introduces or discusses updates to documentation. provider Pertains to the provider itself, rather than any interaction with AWS. size/M Managed by automation to categorize the size of a PR.
Projects
None yet
Milestone
v3.64.0
Development

Successfully merging this pull request may close these issues.
3 participants
@zhelding @ewbankkit @YakDriver