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

aws_s3_bucket_inventory attribute bucket documentation is confusing #14708

Closed
nairb774 opened this issue Aug 17, 2020 · 3 comments · Fixed by #14726
Closed

aws_s3_bucket_inventory attribute bucket documentation is confusing #14708

nairb774 opened this issue Aug 17, 2020 · 3 comments · Fixed by #14726
Labels
documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/s3 Issues and PRs that pertain to the s3 service.
Milestone

Comments

@nairb774
Copy link

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue 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 issue followers and do not help prioritize the request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

Affected Resource(s)

  • aws_s3_bucket_inventory

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_inventory

Documentation says:

bucket - (Required) The name of the bucket where the inventory configuration will be stored.

which is partially confusing because the inventory configuration isn't really stored in the bucket. A slightly better wording might be to swap "stored" for "applied":

bucket - (Required) The name of the bucket where the inventory configuration will be applied.

@ghost ghost added the service/s3 Issues and PRs that pertain to the s3 service. label Aug 17, 2020
@github-actions github-actions bot added the needs-triage Waiting for first response or review from a maintainer. label Aug 17, 2020
@bflad bflad added documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. and removed needs-triage Waiting for first response or review from a maintainer. labels Aug 18, 2020
@bflad
Copy link
Member

bflad commented Aug 18, 2020

Hi @nairb774 👋 If you or anyone would like to adjust this documentation, the source file lives at website/docs/r/s3_bucket_inventory.html.markdown in this repository.

@ghost
Copy link

ghost commented Aug 20, 2020

This has been released in version 3.3.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 for triage. Thanks!

@ghost
Copy link

ghost commented Sep 18, 2020

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 feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@hashicorp hashicorp locked and limited conversation to collaborators Sep 18, 2020
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. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/s3 Issues and PRs that pertain to the s3 service.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants