Skip to content

Commit

Permalink
update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
parthea committed Nov 26, 2024
1 parent 704abb0 commit 1c064cd
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions packages/google-cloud-memorystore/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "google-cloud-memorystore",
"name_pretty": "",
"api_description": "",
"product_documentation": "",
"name_pretty": "Memorystore",
"api_description": "Memorystore for Valkey is a fully managed Valkey Cluster service for Google Cloud. Applications running on Google Cloud can achieve extreme performance by leveraging the highly scalable, available, secure Valkey service without the burden of managing complex Valkey deployments.",
"product_documentation": "https://cloud.google.com/memorystore/docs/valkey",
"client_documentation": "https://cloud.google.com/python/docs/reference/google-cloud-memorystore/latest",
"issue_tracker": "https://github.com/googleapis/google-cloud-python/issues",
"release_level": "preview",
Expand Down
20 changes: 10 additions & 10 deletions packages/google-cloud-memorystore/README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Python Client for
==================
Python Client for Memorystore
=============================

|preview| |pypi| |versions|

``_:
`Memorystore`_: Memorystore for Valkey is a fully managed Valkey Cluster service for Google Cloud. Applications running on Google Cloud can achieve extreme performance by leveraging the highly scalable, available, secure Valkey service without the burden of managing complex Valkey deployments.

- `Client Library Documentation`_
- `Product Documentation`_
Expand All @@ -14,9 +14,9 @@ Python Client for
:target: https://pypi.org/project/google-cloud-memorystore/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-memorystore.svg
:target: https://pypi.org/project/google-cloud-memorystore/
.. _:
.. _Memorystore: https://cloud.google.com/memorystore/docs/valkey
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-memorystore/latest/summary_overview
.. _Product Documentation:
.. _Product Documentation: https://cloud.google.com/memorystore/docs/valkey

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 .`_
3. `Enable the Memorystore.`_
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 .:
.. _Enable the Memorystore.: https://cloud.google.com/memorystore/docs/valkey
.. _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
- Read the `Client Library Documentation`_ for Memorystore
to see other available methods on the client.
- Read the ` Product documentation`_ to learn
- Read the `Memorystore 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.

.. _ Product documentation:
.. _Memorystore Product documentation: https://cloud.google.com/memorystore/docs/valkey
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
2 changes: 1 addition & 1 deletion packages/google-cloud-memorystore/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. include:: multiprocessing.rst

This package includes clients for multiple versions of .
This package includes clients for multiple versions of Memorystore.
By default, you will get version ``memorystore_v1``.


Expand Down
6 changes: 3 additions & 3 deletions packages/google-cloud-memorystore/docs/summary_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ reverted. Instead, if you want to place additional content, create an
pick up on the content and merge the content.
]: #

# API
# Memorystore API

Overview of the APIs available for API.
Overview of the APIs available for Memorystore API.

## All entries

Classes, methods and properties & attributes for
API.
Memorystore API.

[classes](https://cloud.google.com/python/docs/reference/google-cloud-memorystore/latest/summary_class.html)

Expand Down

0 comments on commit 1c064cd

Please sign in to comment.