-
Notifications
You must be signed in to change notification settings - Fork 1.8k
fix: (storage) update doc to link google_storage_bucket_object_content in google_storage_bucket_object #12854
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
fix: (storage) update doc to link google_storage_bucket_object_content in google_storage_bucket_object #12854
Conversation
What is the need of this change? |
to navigate users better to know about the data source resource of bucket objects, a bug raised for by user seeking examples of datasource resource for bucket objects but it exists without navigation in documentation |
Hello! I am a robot. Tests will require approval from a repository maintainer to run. @NickElliot, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look. You can help make sure that review is quick by doing a self-review and by running impacted tests locally. |
@@ -13,6 +13,10 @@ Creates a new object inside an existing bucket in Google cloud storage service ( | |||
and | |||
[API](https://cloud.google.com/storage/docs/json_api/v1/objects). | |||
|
|||
A datasource can be used to retrive data of the object | |||
|
|||
* `google_storage_bucket_object_content`: Retrieves the data of the object |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please add link to the data source? It will help users to directly navigate to data source reference documentation.
nit: "Retrieves the data of the object."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you mean the terraform final documentation URL link? we don't know it and there is no specific documentation for the google_storage_bucket_object_content in Google docs
updated description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds Good!
Actually I was talking about this documentation but it's fine. We can follow same pattern here that was used in other resources.
Also please make sure to keep none
as release-note type since there is no user impact with this change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes release-note is none type
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reworded, let me know if these sound better to you
mmv1/third_party/terraform/website/docs/r/storage_bucket_object.html.markdown
Outdated
Show resolved
Hide resolved
mmv1/third_party/terraform/website/docs/r/storage_bucket_object.html.markdown
Outdated
Show resolved
Hide resolved
…t.html.markdown Co-authored-by: Nick Elliot <[email protected]>
…t.html.markdown Co-authored-by: Nick Elliot <[email protected]>
Updated with the suggestion |
c147b6b
…t in google_storage_bucket_object (GoogleCloudPlatform#12854) Co-authored-by: Nick Elliot <[email protected]>
…t in google_storage_bucket_object (GoogleCloudPlatform#12854) Co-authored-by: Nick Elliot <[email protected]>
Release Note Template for Downstream PRs (will be copied)
See Write release notes for guidance.