Skip to content

Commit 97a4353

Browse files
tseavertseaver
authored
Docs: Replace links to '/stable/' with '/latest/'. (#5901)
* Replace links to '/stable/' with '/latest/'. * DRY out duplicated 'README.rst' vs. 'docs/index.rst'. * Include websecurityscanner in docs. Toward #5894.
1 parent de5b775 commit 97a4353

File tree

31 files changed

+70
-858
lines changed

31 files changed

+70
-858
lines changed

‎README.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ The following client libraries have **alpha** support:
6666
- `Google Cloud Memorystore for Redis`_ (`Redis README`_)
6767
- `Google Cloud Resource Manager`_ (`Resource Manager README`_)
6868
- `Google Cloud Runtime Configuration`_ (`Runtime Config README`_)
69+
- `Google Cloud Web Security Scanner`_ (`Web Security Scanner README`_ )
6970
- `Stackdriver Error Reporting`_ (`Error Reporting README`_)
7071
- `Stackdriver Monitoring`_ (`Monitoring README`_)
7172

@@ -120,6 +121,8 @@ updates. See `versioning`_ for more details.
120121
.. _Redis README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/redis
121122
.. _Google Cloud AutoML: https://pypi.org/project/google-cloud-automl/
122123
.. _AutoML README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/automl
124+
.. _Google Cloud Security Scanner: https://pypi.org/project/google-cloud-websecurityscanner/
125+
.. _Web Security Scanner README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/websecurityscanner
123126

124127
If you need support for other Google APIs, check out the
125128
`Google APIs Python Client library`_.

‎asset/README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Python Client for Cloud Asset API (`Alpha`_)
88

99
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1010
.. _Cloud Asset API: https://cloud.google.com/cloudasset
11-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/cloudasset/usage.html
11+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/asset/index.html
1212
.. _Product Documentation: https://cloud.google.com/cloudasset
1313

1414
Quick Start
@@ -24,7 +24,7 @@ In order to use this library, you first need to go through the following steps:
2424
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
2525
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
2626
.. _Enable the Cloud Asset API.: https://cloud.google.com/cloudasset
27-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
27+
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
2828

2929
Installation
3030
~~~~~~~~~~~~
@@ -72,4 +72,4 @@ Next Steps
7272
APIs that we cover.
7373

7474
.. _Cloud Asset API Product documentation: https://cloud.google.com/cloudasset
75-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
75+
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst

‎asset/docs/index.rst‎

Lines changed: 2 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,9 @@
1-
Python Client for Cloud Asset API (`Alpha`_)
2-
============================================
3-
4-
`Cloud Asset API`_: The cloud asset API manages the history and inventory of cloud resources.
5-
6-
- `Client Library Documentation`_
7-
- `Product Documentation`_
8-
9-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
10-
.. _Cloud Asset API: https://cloud.google.com/cloudasset
11-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/cloudasset/usage.html
12-
.. _Product Documentation: https://cloud.google.com/cloudasset
13-
14-
Quick Start
15-
-----------
16-
17-
In order to use this library, you first need to go through the following steps:
18-
19-
1. `Select or create a Cloud Platform project.`_
20-
2. `Enable billing for your project.`_
21-
3. `Enable the Cloud Asset API.`_
22-
4. `Setup Authentication.`_
23-
24-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
25-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
26-
.. _Enable the Cloud Asset API.: https://cloud.google.com/cloudasset
27-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
28-
29-
Installation
30-
~~~~~~~~~~~~
31-
32-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
33-
create isolated Python environments. The basic problem it addresses is one of
34-
dependencies and versions, and indirectly permissions.
35-
36-
With `virtualenv`_, it's possible to install this library without needing system
37-
install permissions, and without clashing with the installed system
38-
dependencies.
39-
40-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
41-
42-
43-
Mac/Linux
44-
^^^^^^^^^
45-
46-
.. code-block:: console
47-
48-
pip install virtualenv
49-
virtualenv <your-env>
50-
source <your-env>/bin/activate
51-
<your-env>/bin/pip install google-cloud-cloudasset
52-
53-
54-
Windows
55-
^^^^^^^
56-
57-
.. code-block:: console
58-
59-
pip install virtualenv
60-
virtualenv <your-env>
61-
<your-env>\Scripts\activate
62-
<your-env>\Scripts\pip.exe install google-cloud-cloudasset
63-
64-
Next Steps
65-
~~~~~~~~~~
66-
67-
- Read the `Client Library Documentation`_ for Cloud Asset API
68-
API to see other available methods on the client.
69-
- Read the `Cloud Asset API Product documentation`_ to learn
70-
more about the product and see How-to Guides.
71-
- View this `repository’s main README`_ to see the full list of Cloud
72-
APIs that we cover.
73-
74-
.. _Cloud Asset API Product documentation: https://cloud.google.com/cloudasset
75-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1+
.. include:: /../asset/README.rst
762

773
Api Reference
784
-------------
795
.. toctree::
806
:maxdepth: 2
817

828
gapic/v1beta1/api
83-
gapic/v1beta1/types
9+
gapic/v1beta1/types

‎automl/docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In order to use this library, you first need to go through the following steps:
2222
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
2323
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
2424
.. _Enable the Cloud AutoML API.: https://cloud.google.com/automl
25-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
25+
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
2626

2727
Installation
2828
~~~~~~~~~~~~

‎bigtable/docs/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cloud project.
99

1010
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1111
.. _Cloud Bigtable API: https://cloud.google.com/bigtable
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/bigtable/usage.html
12+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/bigtable/usage.html
1313
.. _Product Documentation: https://cloud.google.com/bigtable
1414

1515
Quick Start
@@ -25,7 +25,7 @@ In order to use this library, you first need to go through the following steps:
2525
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
2626
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
2727
.. _Enable the Cloud Bigtable API.: https://cloud.google.com/bigtable
28-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
28+
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
2929

3030
Installation
3131
~~~~~~~~~~~~
@@ -81,4 +81,4 @@ Api Reference
8181
:maxdepth: 2
8282

8383
gapic/v2/api
84-
gapic/v2/types
84+
gapic/v2/types

‎datastore/docs/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ scalable storage for your application.
99

1010
.. _Beta: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1111
.. _Google Cloud Datastore API: https://cloud.google.com/datastore
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/datastore/usage.html
12+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/datastore/usage.html
1313
.. _Product Documentation: https://cloud.google.com/datastore
1414

1515
Quick Start
@@ -25,7 +25,7 @@ In order to use this library, you first need to go through the following steps:
2525
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
2626
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
2727
.. _Enable the Google Cloud Datastore API.: https://cloud.google.com/datastore
28-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
28+
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
2929

3030
Installation
3131
~~~~~~~~~~~~
@@ -81,4 +81,4 @@ Api Reference
8181
:maxdepth: 2
8282

8383
gapic/v1/api
84-
gapic/v1/types
84+
gapic/v1/types

‎dlp/README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ storage repositories.
1010

1111
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1212
.. _Cloud Data Loss Prevention (DLP) API: https://cloud.google.com/dlp
13-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/dlp/usage.html
13+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/dlp/index.html
1414
.. _Product Documentation: https://cloud.google.com/dlp
1515

1616
Quick Start
@@ -26,7 +26,7 @@ In order to use this library, you first need to go through the following steps:
2626
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
2727
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
2828
.. _Enable the Cloud Data Loss Prevention (DLP) API.: https://cloud.google.com/dlp
29-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
29+
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
3030

3131
Installation
3232
~~~~~~~~~~~~
@@ -97,4 +97,4 @@ Next Steps
9797
APIs that we cover.
9898

9999
.. _Cloud Data Loss Prevention (DLP) API Product documentation: https://cloud.google.com/dlp
100-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
100+
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst

‎dlp/docs/index.rst‎

Lines changed: 1 addition & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,4 @@
1-
Python Client for Cloud Data Loss Prevention (DLP) API (`Alpha`_)
2-
=================================================================
3-
4-
`Cloud Data Loss Prevention (DLP) API`_: Provides methods for detection, risk analysis, and de-identification of
5-
privacy-sensitive fragments in text, images, and Google Cloud Platform
6-
storage repositories.
7-
8-
- `Client Library Documentation`_
9-
- `Product Documentation`_
10-
11-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
12-
.. _Cloud Data Loss Prevention (DLP) API: https://cloud.google.com/dlp
13-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/dlp/usage.html
14-
.. _Product Documentation: https://cloud.google.com/dlp
15-
16-
Quick Start
17-
-----------
18-
19-
In order to use this library, you first need to go through the following steps:
20-
21-
1. `Select or create a Cloud Platform project.`_
22-
2. `Enable billing for your project.`_
23-
3. `Enable the Cloud Data Loss Prevention (DLP) API.`_
24-
4. `Setup Authentication.`_
25-
26-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
27-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
28-
.. _Enable the Cloud Data Loss Prevention (DLP) API.: https://cloud.google.com/dlp
29-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
30-
31-
Installation
32-
~~~~~~~~~~~~
33-
34-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
35-
create isolated Python environments. The basic problem it addresses is one of
36-
dependencies and versions, and indirectly permissions.
37-
38-
With `virtualenv`_, it's possible to install this library without needing system
39-
install permissions, and without clashing with the installed system
40-
dependencies.
41-
42-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
43-
44-
45-
Mac/Linux
46-
^^^^^^^^^
47-
48-
.. code-block:: console
49-
50-
pip install virtualenv
51-
virtualenv <your-env>
52-
source <your-env>/bin/activate
53-
<your-env>/bin/pip install google-cloud-dlp
54-
55-
56-
Windows
57-
^^^^^^^
58-
59-
.. code-block:: console
60-
61-
pip install virtualenv
62-
virtualenv <your-env>
63-
<your-env>\Scripts\activate
64-
<your-env>\Scripts\pip.exe install google-cloud-dlp
65-
66-
Next Steps
67-
~~~~~~~~~~
68-
69-
- Read the `Client Library Documentation`_ for Cloud Data Loss Prevention (DLP) API
70-
API to see other available methods on the client.
71-
- Read the `Cloud Data Loss Prevention (DLP) API Product documentation`_ to learn
72-
more about the product and see How-to Guides.
73-
- View this `repository’s main README`_ to see the full list of Cloud
74-
APIs that we cover.
75-
76-
.. _Cloud Data Loss Prevention (DLP) API Product documentation: https://cloud.google.com/dlp
77-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1+
.. include:: /../dlp/README.rst
782

793
Api Reference
804
-------------

‎docs/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
translate/usage
3535
vision/index
3636
videointelligence/index
37+
websecurityscanner/index
3738

3839
Google Cloud Client Library for Python
3940
======================================

‎docs/requirements.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,5 @@ recommonmark >= 0.4.0
3535
-e trace/
3636
-e translate/
3737
-e videointelligence/
38-
-e vision/
38+
-e vision/
39+
-e websecurityscanner/

0 commit comments

Comments
 (0)