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: Update README #12543

Merged
merged 8 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/google-cloud-storage-control/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "google-cloud-storage-control",
"name_pretty": "Cloud Storage",
"api_description": "Lets you store and retrieve potentially-large, immutable data objects.",
"product_documentation": "https://cloud.google.com/storage/docs/overview",
"name_pretty": "Storage Control API",
"api_description": "Lets you perform metadata-specific, control plane, and long-running operations apart from the Storage API. Separating these operations from the Storage API improves API standardization and lets you run faster releases.",
"product_documentation": "https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2",
"client_documentation": "https://cloud.google.com/python/docs/reference/google-cloud-storage-control/latest",
"issue_tracker": "https://issuetracker.google.com/issues/new?component=187243&template=1162869",
"release_level": "preview",
"language": "python",
"library_type": "GAPIC_AUTO",
"repo": "googleapis/google-cloud-python",
"distribution_name": "google-cloud-storage-control",
"api_id": "control.googleapis.com",
"api_id": "storage.googleapis.com",
"default_version": "v2",
"codeowner_team": "",
"api_shortname": "storage"
"api_shortname": "storagecontrol"
}
20 changes: 10 additions & 10 deletions packages/google-cloud-storage-control/README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Python Client for Cloud Storage
===============================
Python Client for Storage Control API
=====================================
Copy link
Contributor

Choose a reason for hiding this comment

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

This file is automatically generated using information in .repo-metadata.json however you can generate the file locally. In a branch of google-cloud-python, run the following commands

Pull the latest docker image

  • docker pull gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo:latest

create a directory which will signal the post processor to regenerate templated files

  • mkdir -p owl-bot-staging/google-cloud-storage-control

Run the post processor locally

  • docker run --user $(id -u):$(id -g) --rm -v $(pwd):/repo -w /repo gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo:latest

Restore autogenerated samples which are erroneously removed as a result of using this process

  • git checkout packages/google-cloud-storage-control/samples

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parthea Thank you for the instructions! Ran post processor and successfully regenerated the README file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there a way to trigger owlbot post processor, if needed? I don't seem to have access to any label triggers. Appreciate any help to merge the PR :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Done


|preview| |pypi| |versions|

`Cloud Storage`_: Lets you store and retrieve potentially-large, immutable data objects.
`Storage Control API`_: Lets you perform metadata-specific, control plane, and long-running operations apart from the Storage API. Separating these operations from the Storage API improves API standardization and lets you run faster releases.

- `Client Library Documentation`_
- `Product Documentation`_
Expand All @@ -14,9 +14,9 @@ Python Client for Cloud Storage
:target: https://pypi.org/project/google-cloud-storage-control/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-storage-control.svg
:target: https://pypi.org/project/google-cloud-storage-control/
.. _Cloud Storage: https://cloud.google.com/storage/docs/overview
.. _Storage Control API: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-storage-control/latest
.. _Product Documentation: https://cloud.google.com/storage/docs/overview
.. _Product Documentation: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2

Quick Start
-----------
Expand All @@ -25,12 +25,12 @@ In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Cloud Storage.`_
3. `Enable the Storage Control API.`_
4. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Cloud Storage.: https://cloud.google.com/storage/docs/overview
.. _Enable the Storage Control API.: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
Expand Down Expand Up @@ -97,12 +97,12 @@ Windows
Next Steps
~~~~~~~~~~

- Read the `Client Library Documentation`_ for Cloud Storage
- Read the `Client Library Documentation`_ for Storage Control API
to see other available methods on the client.
- Read the `Cloud Storage Product documentation`_ to learn
- Read the `Storage Control API Product documentation`_ to learn
more about the product and see How-to Guides.
- View this `README`_ to see the full list of Cloud
APIs that we cover.

.. _Cloud Storage Product documentation: https://cloud.google.com/storage/docs/overview
.. _Storage Control API Product documentation: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst