Skip to content

Commit

Permalink
Docs: normalize use of support level badges (#6159)
Browse files Browse the repository at this point in the history
* Remove badges for deprecated umbrella 'google-cloud' package.

* Clarify support levels.

- Add explicit section to support linking from sub-package README badges.
- Move explanatory text for a support level above the list of packages
  at that level.

* Normalize use of support-level badges in READMEs.

- Note that 'error_reporting/README.rst' and 'monitoring/README.rst' are
  undergoing other edits;  they are left out here to avoid conflicts.

* Use 'General Avaialblity' for support level.

Fix linkx in related API READMEs.

* Fix links for alpha support in API READMEs.

* Fix links for beta support in API READMEs.
  • Loading branch information
tseaver authored Oct 17, 2018
1 parent f0179f1 commit ca71e4b
Show file tree
Hide file tree
Showing 29 changed files with 151 additions and 109 deletions.
72 changes: 39 additions & 33 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Google Cloud Python Client
==========================

Python idiomatic client for `Google Cloud Platform`_ services.
Python idiomatic clients for `Google Cloud Platform`_ services.

.. _Google Cloud Platform: https://cloud.google.com/

|circleci| |appveyor| |coverage|

- `Homepage`_
- `API Documentation`_
- `Read The Docs Documentation`_
Expand All @@ -20,15 +18,34 @@ Google Cloud Python Client
.. _Python 3 runtime: https://cloud.google.com/appengine/docs/standard/python3
.. _Python 2 runtime: https://cloud.google.com/appengine/docs/standard/python

General Availability
--------------------

**GA** (general availability) indicates that the client library for a
particular service is stable, and that the code surface will not change in
backwards-incompatible ways unless either absolutely necessary (e.g. because
of critical security issues) or with an extensive deprecation period.
Issues and requests against GA libraries are addressed with the highest
priority.

.. note::

Sub-components of GA libraries explicitly marked as beta in the
import path (e.g. ``google.cloud.language_v1beta2``) should be considered
to be beta.

The following client libraries have **GA** support:

- `Google BigQuery`_ (`BigQuery README`_)
- `Google Cloud Datastore`_ (`Datastore README`_)
- `Google Cloud Natural Language`_ (`Natural Language README`_)
- `Google Cloud Spanner`_ (`Spanner README`_)
- `Google Cloud Storage`_ (`Storage README`_)
- `Google Cloud Translation`_ (`Translation README`_)
- `Stackdriver Logging`_ (`Logging README`_)

.. _Google BigQuery: https://pypi.org/project/google-cloud-bigquery/
.. _BigQuery README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigquery
.. _Google Cloud Datastore: https://pypi.org/project/google-cloud-datastore/
.. _Datastore README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/datastore
.. _Google Cloud Natural Language: https://pypi.org/project/google-cloud-language/
Expand All @@ -42,35 +59,22 @@ The following client libraries have **GA** support:
.. _Stackdriver Logging: https://pypi.org/project/google-cloud-logging/
.. _Logging README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/logging

**GA** (general availability) indicates that the client library for a
particular service is stable, and that the code surface will not change in
backwards-incompatible ways unless either absolutely necessary (e.g. because
of critical security issues) or with an extensive deprecation period.
Issues and requests against GA libraries are addressed with the highest
priority.

.. note::
Beta Support
------------

Sub-components of GA libraries explicitly marked as beta in the
import path (e.g. ``google.cloud.language_v1beta2``) should be considered
to be beta.
**Beta** indicates that the client library for a particular service is
mostly stable and is being prepared for release. Issues and requests
against beta libraries are addressed with a higher priority.

The following client libraries have **beta** support:

- `Google BigQuery`_ (`BigQuery README`_)
- `Google Cloud Bigtable`_ (`Bigtable README`_)
- `Google Cloud Firestore`_ (`Firestore README`_)
- `Google Cloud Pub/Sub`_ (`Pub/Sub README`_)
- `Google Cloud Speech`_ (`Speech README`_)
- `Google Cloud Video Intelligence`_ (`Video Intelligence README`_)
- `Google Cloud Vision`_ (`Vision README`_)

**Beta** indicates that the client library for a particular service is
mostly stable and is being prepared for release. Issues and requests
against beta libraries are addressed with a higher priority.

.. _Google BigQuery: https://pypi.org/project/google-cloud-bigquery/
.. _BigQuery README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigquery
.. _Google Cloud Bigtable: https://pypi.org/project/google-cloud-bigtable/
.. _Bigtable README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigtable
.. _Google Cloud Firestore: https://pypi.org/project/google-cloud-firestore/
Expand All @@ -84,8 +88,17 @@ against beta libraries are addressed with a higher priority.
.. _Google Cloud Vision: https://pypi.org/project/google-cloud-vision/
.. _Vision README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/vision


Alpha Support
-------------

**Alpha** indicates that the client library for a particular service is
still a work-in-progress and is more likely to get backwards-incompatible
updates. See `versioning`_ for more details.

The following client libraries have **alpha** support:

- `Google Cloud Asset`_ (`Asset README`_)
- `Google Cloud AutoML`_ (`AutoML README`_)
- `Google BigQuery Data Transfer`_ (`BigQuery Data Transfer README`_)
- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_)
Expand All @@ -105,10 +118,8 @@ The following client libraries have **alpha** support:
- `Stackdriver Error Reporting`_ (`Error Reporting README`_)
- `Stackdriver Monitoring`_ (`Monitoring README`_)

**Alpha** indicates that the client library for a particular service is
still a work-in-progress and is more likely to get backwards-incompatible
updates. See `versioning`_ for more details.

.. _Google Cloud Asset: https://pypi.org/project/google-cloud-asset/
.. _Asset README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/asset
.. _Google Cloud AutoML: https://pypi.org/project/google-cloud-automl/
.. _AutoML README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/automl
.. _Google BigQuery Data Transfer: https://pypi.org/project/google-cloud-bigquery-datatransfer/
Expand Down Expand Up @@ -164,6 +175,7 @@ Example Applications
.. _tutorial: https://cloud.google.com/python
.. _google-cloud-python-expenses-demo: https://github.com/GoogleCloudPlatform/google-cloud-python-expenses-demo


Authentication
--------------

Expand All @@ -184,26 +196,20 @@ See the `CONTRIBUTING doc`_ for more information on how to get started.

.. _CONTRIBUTING doc: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/CONTRIBUTING.rst


Community
---------

Google Cloud Platform Python developers hang out in `Slack`_ in the ``#python``
channel, click here to `get an invitation`_.


.. _Slack: https://googlecloud-community.slack.com
.. _get an invitation: https://gcp-slack.appspot.com/


License
-------

Apache 2.0 - See `the LICENSE`_ for more information.

.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/LICENSE

.. |circleci| image:: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python.svg?style=shield
:target: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/googlecloudplatform/google-cloud-python?branch=master&svg=true
:target: https://ci.appveyor.com/project/GoogleCloudPlatform/google-cloud-python
.. |coverage| image:: https://coveralls.io/repos/GoogleCloudPlatform/google-cloud-python/badge.svg?branch=master
:target: https://coveralls.io/r/GoogleCloudPlatform/google-cloud-python?branch=master
9 changes: 5 additions & 4 deletions asset/README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
Python Client for Cloud Asset API (`Alpha`_)
============================================
Python Client for Cloud Asset API
=================================

|pypi| |versions|
|alpha| |pypi| |versions|

`Cloud Asset API`_: The cloud asset API manages the history and inventory of cloud resources.

- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-asset.svg
:target: https://pypi.org/project/google-cloud-asset/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-asset.svg
Expand Down
9 changes: 5 additions & 4 deletions automl/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Client for Cloud AutoML API (`Alpha`_)
=============================================
Python Client for Cloud AutoML API
==================================

|pypi| |versions|
|alpha| |pypi| |versions|

The `Cloud AutoML API`_ is a suite of machine learning products that enables
developers with limited machine learning expertise to train high-quality models
Expand All @@ -11,7 +11,8 @@ transfer learning, and Neural Architecture Search technology.
- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-automl.svg
:target: https://pypi.org/project/google-cloud-automl/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-automl.svg
Expand Down
4 changes: 3 additions & 1 deletion bigquery/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Client for Google BigQuery
=================================

|pypi| |versions|
|GA| |pypi| |versions|

Querying massive datasets can be time consuming and expensive without the
right hardware and infrastructure. Google `BigQuery`_ solves this problem by
Expand All @@ -11,6 +11,8 @@ processing power of Google's infrastructure.
- `Client Library Documentation`_
- `Product Documentation`_

.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery.svg
:target: https://pypi.org/project/google-cloud-bigquery/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery.svg
Expand Down
9 changes: 5 additions & 4 deletions bigquery_datatransfer/README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Python Client for BigQuery Data Transfer API (`Alpha`_)
=======================================================
Python Client for BigQuery Data Transfer API
============================================

|pypi| |versions|
|alpha| |pypi| |versions|

The `BigQuery Data Transfer API`_ allows users to transfer data from partner
SaaS applications to Google BigQuery on a scheduled, managed basis.

- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery-datatransfer.svg
:target: https://pypi.org/project/google-cloud-bigquery-datatransfer/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery-datatransfer.svg
Expand Down
10 changes: 5 additions & 5 deletions bigtable/README.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Python Client for Google Cloud Bigtable (`Beta`_)
==================================================

|pypi| |versions|
Python Client for Google Cloud Bigtable
=======================================

|beta| |pypi| |versions|

`Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's the
same database that powers many core Google services, including Search,
Expand All @@ -11,7 +10,8 @@ Analytics, Maps, and Gmail.
- `Client Library Documentation`_
- `Product Documentation`_

.. _Beta: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigtable.svg
:target: https://pypi.org/project/google-cloud-bigtable/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigtable.svg
Expand Down
9 changes: 5 additions & 4 deletions container/README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Python Client for Google Container Engine API (`Alpha`_)
========================================================
Python Client for Google Container Engine API
=============================================

|pypi| |versions|
|alpha| |pypi| |versions|

`Google Container Engine API`_: The Google Kubernetes Engine API is used for building and managing container
based applications, powered by the open source Kubernetes technology.

- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-container.svg
:target: https://pypi.org/project/google-cloud-container/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-container.svg
Expand Down
9 changes: 5 additions & 4 deletions dataproc/README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
Python Client for Google Cloud Dataproc API (`Alpha`_)
======================================================
Python Client for Google Cloud Dataproc API
===========================================

|pypi| |versions|
|alpha| |pypi| |versions|

`Google Cloud Dataproc API`_: Manages Hadoop-based clusters and jobs on Google Cloud Platform.

- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dataproc.svg
:target: https://pypi.org/project/google-cloud-dataproc/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dataproc.svg
Expand Down
4 changes: 3 additions & 1 deletion datastore/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Client for Google Cloud Datastore
========================================

|pypi| |versions|
|GA| |pypi| |versions|

`Google Cloud Datastore API`_ is a fully managed, schemaless database for
storing non-relational data. Cloud Datastore automatically scales with your
Expand All @@ -12,6 +12,8 @@ all other queries.
- `Client Library Documentation`_
- `Product Documentation`_

.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-datastore.svg
:target: https://pypi.org/project/google-cloud-datastore/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-datastore.svg
Expand Down
9 changes: 5 additions & 4 deletions dlp/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Client for Cloud Data Loss Prevention (DLP) API (`Alpha`_)
=================================================================
Python Client for Cloud Data Loss Prevention (DLP) API
======================================================

|pypi| |versions|
|alpha| |pypi| |versions|

`Cloud Data Loss Prevention (DLP) API`_: Provides methods for detection, risk analysis, and de-identification of
privacy-sensitive fragments in text, images, and Google Cloud Platform
Expand All @@ -10,7 +10,8 @@ storage repositories.
- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dlp.svg
:target: https://pypi.org/project/google-cloud-dlp/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dlp.svg
Expand Down
4 changes: 3 additions & 1 deletion dns/README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
Python Client for Google Cloud DNS
==================================

|pypi| |versions|
|alpha| |pypi| |versions|

The `Google Cloud DNS`_ API provides methods that you can use to
manage DNS for your applications.

- `Client Library Documentation`_
- `Product Documentation`_

.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dns.svg
:target: https://pypi.org/project/google-cloud-dns/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dns.svg
Expand Down
4 changes: 3 additions & 1 deletion firestore/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Client for Google Cloud Firestore
========================================

|pypi| |versions|
|beta| |pypi| |versions|

The `Google Cloud Firestore`_ API is a flexible, scalable
database for mobile, web, and server development from Firebase and Google
Expand All @@ -15,6 +15,8 @@ including Cloud Functions.
- `Product Documentation`_
- `Client Library Documentation`_

.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-firestore.svg
:target: https://pypi.org/project/google-cloud-firestore/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-firestore.svg
Expand Down
9 changes: 5 additions & 4 deletions iot/README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Python Client for Cloud IoT API (`Alpha`_)
==========================================
Python Client for Cloud IoT API
===============================

|pypi| |versions|
|alpha| |pypi| |versions|

`Cloud IoT API`_: Registers and manages IoT (Internet of Things) devices that
connect to the Google Cloud Platform.

- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-iot.svg
:target: https://pypi.org/project/google-cloud-iot/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-iot.svg
Expand Down
Loading

0 comments on commit ca71e4b

Please sign in to comment.