Skip to content

Commit ca71e4b

Browse files
tseavertseaver
authored
Docs: normalize use of support level badges (#6159)
* 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.
1 parent f0179f1 commit ca71e4b

File tree

29 files changed

+151
-109
lines changed

29 files changed

+151
-109
lines changed

‎README.rst‎

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
Google Cloud Python Client
22
==========================
33

4-
Python idiomatic client for `Google Cloud Platform`_ services.
4+
Python idiomatic clients for `Google Cloud Platform`_ services.
55

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

8-
|circleci| |appveyor| |coverage|
9-
108
- `Homepage`_
119
- `API Documentation`_
1210
- `Read The Docs Documentation`_
@@ -20,15 +18,34 @@ Google Cloud Python Client
2018
.. _Python 3 runtime: https://cloud.google.com/appengine/docs/standard/python3
2119
.. _Python 2 runtime: https://cloud.google.com/appengine/docs/standard/python
2220

21+
General Availability
22+
--------------------
23+
24+
**GA** (general availability) indicates that the client library for a
25+
particular service is stable, and that the code surface will not change in
26+
backwards-incompatible ways unless either absolutely necessary (e.g. because
27+
of critical security issues) or with an extensive deprecation period.
28+
Issues and requests against GA libraries are addressed with the highest
29+
priority.
30+
31+
.. note::
32+
33+
Sub-components of GA libraries explicitly marked as beta in the
34+
import path (e.g. ``google.cloud.language_v1beta2``) should be considered
35+
to be beta.
36+
2337
The following client libraries have **GA** support:
2438

39+
- `Google BigQuery`_ (`BigQuery README`_)
2540
- `Google Cloud Datastore`_ (`Datastore README`_)
2641
- `Google Cloud Natural Language`_ (`Natural Language README`_)
2742
- `Google Cloud Spanner`_ (`Spanner README`_)
2843
- `Google Cloud Storage`_ (`Storage README`_)
2944
- `Google Cloud Translation`_ (`Translation README`_)
3045
- `Stackdriver Logging`_ (`Logging README`_)
3146

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

45-
**GA** (general availability) indicates that the client library for a
46-
particular service is stable, and that the code surface will not change in
47-
backwards-incompatible ways unless either absolutely necessary (e.g. because
48-
of critical security issues) or with an extensive deprecation period.
49-
Issues and requests against GA libraries are addressed with the highest
50-
priority.
51-
52-
.. note::
62+
Beta Support
63+
------------
5364

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

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

60-
- `Google BigQuery`_ (`BigQuery README`_)
6171
- `Google Cloud Bigtable`_ (`Bigtable README`_)
6272
- `Google Cloud Firestore`_ (`Firestore README`_)
6373
- `Google Cloud Pub/Sub`_ (`Pub/Sub README`_)
6474
- `Google Cloud Speech`_ (`Speech README`_)
6575
- `Google Cloud Video Intelligence`_ (`Video Intelligence README`_)
6676
- `Google Cloud Vision`_ (`Vision README`_)
6777

68-
**Beta** indicates that the client library for a particular service is
69-
mostly stable and is being prepared for release. Issues and requests
70-
against beta libraries are addressed with a higher priority.
71-
72-
.. _Google BigQuery: https://pypi.org/project/google-cloud-bigquery/
73-
.. _BigQuery README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigquery
7478
.. _Google Cloud Bigtable: https://pypi.org/project/google-cloud-bigtable/
7579
.. _Bigtable README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigtable
7680
.. _Google Cloud Firestore: https://pypi.org/project/google-cloud-firestore/
@@ -84,8 +88,17 @@ against beta libraries are addressed with a higher priority.
8488
.. _Google Cloud Vision: https://pypi.org/project/google-cloud-vision/
8589
.. _Vision README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/vision
8690

91+
92+
Alpha Support
93+
-------------
94+
95+
**Alpha** indicates that the client library for a particular service is
96+
still a work-in-progress and is more likely to get backwards-incompatible
97+
updates. See `versioning`_ for more details.
98+
8799
The following client libraries have **alpha** support:
88100

101+
- `Google Cloud Asset`_ (`Asset README`_)
89102
- `Google Cloud AutoML`_ (`AutoML README`_)
90103
- `Google BigQuery Data Transfer`_ (`BigQuery Data Transfer README`_)
91104
- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_)
@@ -105,10 +118,8 @@ The following client libraries have **alpha** support:
105118
- `Stackdriver Error Reporting`_ (`Error Reporting README`_)
106119
- `Stackdriver Monitoring`_ (`Monitoring README`_)
107120

108-
**Alpha** indicates that the client library for a particular service is
109-
still a work-in-progress and is more likely to get backwards-incompatible
110-
updates. See `versioning`_ for more details.
111-
121+
.. _Google Cloud Asset: https://pypi.org/project/google-cloud-asset/
122+
.. _Asset README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/asset
112123
.. _Google Cloud AutoML: https://pypi.org/project/google-cloud-automl/
113124
.. _AutoML README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/automl
114125
.. _Google BigQuery Data Transfer: https://pypi.org/project/google-cloud-bigquery-datatransfer/
@@ -164,6 +175,7 @@ Example Applications
164175
.. _tutorial: https://cloud.google.com/python
165176
.. _google-cloud-python-expenses-demo: https://github.com/GoogleCloudPlatform/google-cloud-python-expenses-demo
166177

178+
167179
Authentication
168180
--------------
169181

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

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

199+
187200
Community
188201
---------
189202

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

193-
194206
.. _Slack: https://googlecloud-community.slack.com
195207
.. _get an invitation: https://gcp-slack.appspot.com/
196208

209+
197210
License
198211
-------
199212

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

202215
.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/LICENSE
203-
204-
.. |circleci| image:: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python.svg?style=shield
205-
:target: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python
206-
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/googlecloudplatform/google-cloud-python?branch=master&svg=true
207-
:target: https://ci.appveyor.com/project/GoogleCloudPlatform/google-cloud-python
208-
.. |coverage| image:: https://coveralls.io/repos/GoogleCloudPlatform/google-cloud-python/badge.svg?branch=master
209-
:target: https://coveralls.io/r/GoogleCloudPlatform/google-cloud-python?branch=master

‎asset/README.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
Python Client for Cloud Asset API (`Alpha`_)
2-
============================================
1+
Python Client for Cloud Asset API
2+
=================================
33

4-
|pypi| |versions|
4+
|alpha| |pypi| |versions|
55

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

88
- `Client Library Documentation`_
99
- `Product Documentation`_
1010

11-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11+
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
12+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
1213
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-asset.svg
1314
:target: https://pypi.org/project/google-cloud-asset/
1415
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-asset.svg

‎automl/README.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Python Client for Cloud AutoML API (`Alpha`_)
2-
=============================================
1+
Python Client for Cloud AutoML API
2+
==================================
33

4-
|pypi| |versions|
4+
|alpha| |pypi| |versions|
55

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

14-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
14+
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
15+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
1516
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-automl.svg
1617
:target: https://pypi.org/project/google-cloud-automl/
1718
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-automl.svg

‎bigquery/README.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for Google BigQuery
22
=================================
33

4-
|pypi| |versions|
4+
|GA| |pypi| |versions|
55

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

14+
.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
15+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability
1416
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery.svg
1517
:target: https://pypi.org/project/google-cloud-bigquery/
1618
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery.svg

‎bigquery_datatransfer/README.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
Python Client for BigQuery Data Transfer API (`Alpha`_)
2-
=======================================================
1+
Python Client for BigQuery Data Transfer API
2+
============================================
33

4-
|pypi| |versions|
4+
|alpha| |pypi| |versions|
55

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

99
- `Client Library Documentation`_
1010
- `Product Documentation`_
1111

12-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
12+
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
13+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
1314
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery-datatransfer.svg
1415
:target: https://pypi.org/project/google-cloud-bigquery-datatransfer/
1516
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigquery-datatransfer.svg

‎bigtable/README.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
Python Client for Google Cloud Bigtable (`Beta`_)
2-
==================================================
3-
4-
|pypi| |versions|
1+
Python Client for Google Cloud Bigtable
2+
=======================================
53

4+
|beta| |pypi| |versions|
65

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

14-
.. _Beta: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
13+
.. |beta| image:: https://img.shields.io/badge/support-beta-silver.svg
14+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support
1515
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigtable.svg
1616
:target: https://pypi.org/project/google-cloud-bigtable/
1717
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigtable.svg

‎container/README.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
Python Client for Google Container Engine API (`Alpha`_)
2-
========================================================
1+
Python Client for Google Container Engine API
2+
=============================================
33

4-
|pypi| |versions|
4+
|alpha| |pypi| |versions|
55

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

99
- `Client Library Documentation`_
1010
- `Product Documentation`_
1111

12-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
12+
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
13+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
1314
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-container.svg
1415
:target: https://pypi.org/project/google-cloud-container/
1516
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-container.svg

‎dataproc/README.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
Python Client for Google Cloud Dataproc API (`Alpha`_)
2-
======================================================
1+
Python Client for Google Cloud Dataproc API
2+
===========================================
33

4-
|pypi| |versions|
4+
|alpha| |pypi| |versions|
55

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

88
- `Client Library Documentation`_
99
- `Product Documentation`_
1010

11-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11+
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
12+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
1213
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dataproc.svg
1314
:target: https://pypi.org/project/google-cloud-dataproc/
1415
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dataproc.svg

‎datastore/README.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Python Client for Google Cloud Datastore
22
========================================
33

4-
|pypi| |versions|
4+
|GA| |pypi| |versions|
55

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

15+
.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
16+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability
1517
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-datastore.svg
1618
:target: https://pypi.org/project/google-cloud-datastore/
1719
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-datastore.svg

‎dlp/README.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Python Client for Cloud Data Loss Prevention (DLP) API (`Alpha`_)
2-
=================================================================
1+
Python Client for Cloud Data Loss Prevention (DLP) API
2+
======================================================
33

4-
|pypi| |versions|
4+
|alpha| |pypi| |versions|
55

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

13-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
13+
.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
14+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
1415
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dlp.svg
1516
:target: https://pypi.org/project/google-cloud-dlp/
1617
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dlp.svg

0 commit comments

Comments
 (0)