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

Update READMEs. #8456

Merged
merged 2 commits into from
Jun 24, 2019
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ The following client libraries have **alpha** support:
- `Google BigQuery Data Transfer`_ (`BigQuery Data Transfer README`_)
- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_)
- `Google Cloud Container`_ (`Container README`_)
- `Google Cloud Container Analysis`_ (`Container Analysis README`_)
- `Google Cloud Dataproc`_ (`Dataproc README`_)
- `Google Cloud DLP`_ (`DLP README`_)
- `Google Cloud DNS`_ (`DNS README`_)
Expand All @@ -123,6 +124,7 @@ The following client libraries have **alpha** support:
- `Google Cloud Tasks`_ (`Tasks README`_)
- `Google Cloud Trace`_ (`Trace README`_)
- `Google Cloud Text-to-Speech`_ (`Text-to-Speech README`_)
- `Grafeas_ (`Grafeas README`_)
- `Stackdriver Error Reporting`_ (`Error Reporting README`_)
- `Stackdriver Monitoring`_ (`Monitoring README`_)

Expand All @@ -136,6 +138,8 @@ The following client libraries have **alpha** support:
.. _HappyBase README: https://github.com/googleapis/google-cloud-python-happybase
.. _Google Cloud Container: https://pypi.org/project/google-cloud-container/
.. _Container README: https://github.com/googleapis/google-cloud-python/tree/master/container
.. _Google Cloud Container Analysis: https://pypi.org/project/google-cloud-containeranalysis/
.. _Container Analysis README: https://github.com/googleapis/google-cloud-python/tree/master/containeranalysis
.. _Google Cloud Dataproc: https://pypi.org/project/google-cloud-dataproc/
.. _Dataproc README: https://github.com/googleapis/google-cloud-python/tree/master/dataproc
.. _Google Cloud DLP: https://pypi.org/project/google-cloud-dlp/
Expand All @@ -156,6 +160,8 @@ The following client libraries have **alpha** support:
.. _Text-to-Speech README: https://github.com/googleapis/google-cloud-python/tree/master/texttospeech
.. _Google Cloud Trace: https://pypi.org/project/google-cloud-trace/
.. _Trace README: https://github.com/googleapis/google-cloud-python/tree/master/trace
.. _Grafeas: https://pypi.org/project/grafeas/
.. _Grafeas README: https://github.com/googleapis/google-cloud-python/tree/master/grafeas
.. _Stackdriver Error Reporting: https://pypi.org/project/google-cloud-error-reporting/
.. _Error Reporting README: https://github.com/googleapis/google-cloud-python/tree/master/error_reporting
.. _Stackdriver Monitoring: https://pypi.org/project/google-cloud-monitoring/
Expand Down
2 changes: 1 addition & 1 deletion containeranalysis/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and retrieval of critical metadata about all of your software artifacts.

.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _Container Analysis API: https://cloud.google.com/container-registry/docs/container-analysis
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/containeranalysis/usage.html
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/containeranalysis/index.html
.. _Product Documentation: https://cloud.google.com/container-registry/docs/container-analysis

Quick Start
Expand Down
27 changes: 6 additions & 21 deletions grafeas/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,12 @@ retrieval of critical metadata about all of your software artifacts.
- `Product Documentation`_

.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _Grafeas API: https://cloud.google.com/grafeas
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/grafeas/usage.html
.. _Product Documentation: https://cloud.google.com/grafeas

Quick Start
-----------

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 Grafeas 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 Grafeas API.: https://cloud.google.com/grafeas
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Grafeas API: https://grafeas.io/
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/grafeas/index.html
.. _Product Documentation: https://grafeas.io/

Installation
~~~~~~~~~~~~
--------------

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
Expand Down Expand Up @@ -63,7 +48,7 @@ Windows
<your-env>\Scripts\pip.exe install grafeas

Next Steps
~~~~~~~~~~
--------------

- Read the `Client Library Documentation`_ for Grafeas API
API to see other available methods on the client.
Expand All @@ -72,5 +57,5 @@ Next Steps
- View this `repository’s main README`_ to see the full list of Cloud
APIs that we cover.

.. _Grafeas API Product documentation: https://cloud.google.com/grafeas
.. _Grafeas API Product documentation: https://grafeas.io/
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst