Skip to content

Commit

Permalink
docs: Update README (#12543)
Browse files Browse the repository at this point in the history
It seems like we can update `google-cloud-storage-control` repo metadata
directly. Please LMK if the patch should be made elsewhere.

Fixes #12532

---------

Co-authored-by: ohmayr <omairnaveed@ymail.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
3 people committed Apr 3, 2024
1 parent 2d7225c commit 30b7a8f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
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
=====================================

|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

0 comments on commit 30b7a8f

Please sign in to comment.