Skip to content

Commit af12aa3

Browse files
waprinwaprin
authored
Fix README rst links (#962)
* Fix README rst links * Update all READMEs
1 parent e4d2035 commit af12aa3

File tree

28 files changed

+96
-88
lines changed

28 files changed

+96
-88
lines changed

‎bigquery/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -326,11 +326,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
326326
You can read the documentation for more details on API usage and use GitHub
327327
to `browse the source`_ and `report issues`_.
328328

329-
.. Google Cloud Client Library for Python:
329+
.. _Google Cloud Client Library for Python:
330330
https://googlecloudplatform.github.io/google-cloud-python/
331-
.. browse the source:
331+
.. _browse the source:
332332
https://github.com/GoogleCloudPlatform/google-cloud-python
333-
.. report issues:
333+
.. _report issues:
334334
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
335335

336336

‎bigquery/dml/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
139139
You can read the documentation for more details on API usage and use GitHub
140140
to `browse the source`_ and `report issues`_.
141141

142-
.. Google Cloud Client Library for Python:
142+
.. _Google Cloud Client Library for Python:
143143
https://googlecloudplatform.github.io/google-cloud-python/
144-
.. browse the source:
144+
.. _browse the source:
145145
https://github.com/GoogleCloudPlatform/google-cloud-python
146-
.. report issues:
146+
.. _report issues:
147147
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
148148

149149

‎bigtable/autoscaler/README.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This directory contains samples for Google Cloud Bigtable. `Google Cloud Bigtabl
99
This sample demonstrates using `Stackdriver monitoring`_,
1010
to scale Cloud Bigtable based on CPU usage.
1111

12-
.. Stackdriver Monitoring: http://cloud.google.com/monitoring/docs
12+
.. _Stackdriver Monitoring: http://cloud.google.com/monitoring/docs
1313

1414

1515
.. _Google Cloud Bigtable: https://cloud.google.com/bigtable/docs
@@ -88,12 +88,13 @@ To run this sample:
8888
usage: autoscaler.py [-h] [--high_cpu_threshold HIGH_CPU_THRESHOLD]
8989
[--low_cpu_threshold LOW_CPU_THRESHOLD]
9090
[--short_sleep SHORT_SLEEP] [--long_sleep LONG_SLEEP]
91-
instance_id
91+
bigtable_instance bigtable_cluster
9292
9393
Scales Bigtable clusters based on CPU usage.
9494
9595
positional arguments:
96-
instance_id ID of the Cloud Bigtable instance to connect to.
96+
bigtable_instance ID of the Cloud Bigtable instance to connect to.
97+
bigtable_cluster ID of the Cloud Bigtable cluster to connect to.
9798
9899
optional arguments:
99100
-h, --help show this help message and exit
@@ -120,11 +121,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
120121
You can read the documentation for more details on API usage and use GitHub
121122
to `browse the source`_ and `report issues`_.
122123

123-
.. Google Cloud Client Library for Python:
124+
.. _Google Cloud Client Library for Python:
124125
https://googlecloudplatform.github.io/google-cloud-python/
125-
.. browse the source:
126+
.. _browse the source:
126127
https://github.com/GoogleCloudPlatform/google-cloud-python
127-
.. report issues:
128+
.. _report issues:
128129
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
129130

130131

‎bigtable/autoscaler/README.rst.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: |
1313
This sample demonstrates using `Stackdriver monitoring`_,
1414
to scale Cloud Bigtable based on CPU usage.
1515

16-
.. Stackdriver Monitoring: http://cloud.google.com/monitoring/docs
16+
.. _Stackdriver Monitoring: http://cloud.google.com/monitoring/docs
1717

1818
setup:
1919
- auth

‎bigtable/hello/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
108108
You can read the documentation for more details on API usage and use GitHub
109109
to `browse the source`_ and `report issues`_.
110110

111-
.. Google Cloud Client Library for Python:
111+
.. _Google Cloud Client Library for Python:
112112
https://googlecloudplatform.github.io/google-cloud-python/
113-
.. browse the source:
113+
.. _browse the source:
114114
https://github.com/GoogleCloudPlatform/google-cloud-python
115-
.. report issues:
115+
.. _report issues:
116116
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
117117

118118

‎bigtable/hello_happybase/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
115115
You can read the documentation for more details on API usage and use GitHub
116116
to `browse the source`_ and `report issues`_.
117117

118-
.. Google Cloud Client Library for Python:
118+
.. _Google Cloud Client Library for Python:
119119
https://googlecloudplatform.github.io/google-cloud-python/
120-
.. browse the source:
120+
.. _browse the source:
121121
https://github.com/GoogleCloudPlatform/google-cloud-python
122-
.. report issues:
122+
.. _report issues:
123123
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
124124

125125

‎datastore/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
125125
You can read the documentation for more details on API usage and use GitHub
126126
to `browse the source`_ and `report issues`_.
127127

128-
.. Google Cloud Client Library for Python:
128+
.. _Google Cloud Client Library for Python:
129129
https://googlecloudplatform.github.io/google-cloud-python/
130-
.. browse the source:
130+
.. _browse the source:
131131
https://github.com/GoogleCloudPlatform/google-cloud-python
132-
.. report issues:
132+
.. _report issues:
133133
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
134134

135135

‎dns/api/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
9191
You can read the documentation for more details on API usage and use GitHub
9292
to `browse the source`_ and `report issues`_.
9393

94-
.. Google Cloud Client Library for Python:
94+
.. _Google Cloud Client Library for Python:
9595
https://googlecloudplatform.github.io/google-cloud-python/
96-
.. browse the source:
96+
.. _browse the source:
9797
https://github.com/GoogleCloudPlatform/google-cloud-python
98-
.. report issues:
98+
.. _report issues:
9999
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
100100

101101

‎error_reporting/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
9292
You can read the documentation for more details on API usage and use GitHub
9393
to `browse the source`_ and `report issues`_.
9494

95-
.. Google Cloud Client Library for Python:
95+
.. _Google Cloud Client Library for Python:
9696
https://googlecloudplatform.github.io/google-cloud-python/
97-
.. browse the source:
97+
.. _browse the source:
9898
https://github.com/GoogleCloudPlatform/google-cloud-python
99-
.. report issues:
99+
.. _report issues:
100100
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
101101

102102

‎language/cloud-client/v1/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
128128
You can read the documentation for more details on API usage and use GitHub
129129
to `browse the source`_ and `report issues`_.
130130

131-
.. Google Cloud Client Library for Python:
131+
.. _Google Cloud Client Library for Python:
132132
https://googlecloudplatform.github.io/google-cloud-python/
133-
.. browse the source:
133+
.. _browse the source:
134134
https://github.com/GoogleCloudPlatform/google-cloud-python
135-
.. report issues:
135+
.. _report issues:
136136
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
137137

138138

‎language/cloud-client/v1beta2/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,11 +133,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
133133
You can read the documentation for more details on API usage and use GitHub
134134
to `browse the source`_ and `report issues`_.
135135

136-
.. Google Cloud Client Library for Python:
136+
.. _Google Cloud Client Library for Python:
137137
https://googlecloudplatform.github.io/google-cloud-python/
138-
.. browse the source:
138+
.. _browse the source:
139139
https://github.com/GoogleCloudPlatform/google-cloud-python
140-
.. report issues:
140+
.. _report issues:
141141
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
142142

143143

‎logging/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,11 +152,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
152152
You can read the documentation for more details on API usage and use GitHub
153153
to `browse the source`_ and `report issues`_.
154154
155-
.. Google Cloud Client Library for Python:
155+
.. _Google Cloud Client Library for Python:
156156
https://googlecloudplatform.github.io/google-cloud-python/
157-
.. browse the source:
157+
.. _browse the source:
158158
https://github.com/GoogleCloudPlatform/google-cloud-python
159-
.. report issues:
159+
.. _report issues:
160160
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
161161
162162

‎monitoring/api/v3/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
128128
You can read the documentation for more details on API usage and use GitHub
129129
to `browse the source`_ and `report issues`_.
130130

131-
.. Google Cloud Client Library for Python:
131+
.. _Google Cloud Client Library for Python:
132132
https://googlecloudplatform.github.io/google-cloud-python/
133-
.. browse the source:
133+
.. _browse the source:
134134
https://github.com/GoogleCloudPlatform/google-cloud-python
135-
.. report issues:
135+
.. _report issues:
136136
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
137137

138138

‎pubsub/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,11 +192,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
192192
You can read the documentation for more details on API usage and use GitHub
193193
to `browse the source`_ and `report issues`_.
194194

195-
.. Google Cloud Client Library for Python:
195+
.. _Google Cloud Client Library for Python:
196196
https://googlecloudplatform.github.io/google-cloud-python/
197-
.. browse the source:
197+
.. _browse the source:
198198
https://github.com/GoogleCloudPlatform/google-cloud-python
199-
.. report issues:
199+
.. _report issues:
200200
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
201201

202202

‎scripts/readme-gen/templates/README.tmpl.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
5555
You can read the documentation for more details on API usage and use GitHub
5656
to `browse the source`_ and `report issues`_.
5757

58-
.. Google Cloud Client Library for Python:
58+
.. _Google Cloud Client Library for Python:
5959
https://googlecloudplatform.github.io/google-cloud-python/
60-
.. browse the source:
60+
.. _browse the source:
6161
https://github.com/GoogleCloudPlatform/google-cloud-python
62-
.. report issues:
62+
.. _report issues:
6363
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
6464

6565
{% endif %}

‎spanner/cloud-client/README.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,16 @@ To run this sample:
129129
particular timestamp.
130130
add_index Adds a simple index to the example database.
131131
query_data_with_index
132-
Inserts sample data into the given database. The
133-
database and table must already exist and can be
134-
created using `create_database`.
132+
Queries sample data from the database using SQL and an
133+
index. The index must exist before running this
134+
sample. You can add the index by running the
135+
`add_index` sample or by running this DDL statement
136+
against your database: CREATE INDEX AlbumsByAlbumTitle
137+
ON Albums(AlbumTitle) This sample also uses the
138+
`MarketingBudget` column. You can add the column by
139+
running the `add_column` sample or by running this DDL
140+
statement against your database: ALTER TABLE Albums
141+
ADD COLUMN MarketingBudget INT64
135142
read_data_with_index
136143
Inserts sample data into the given database. The
137144
database and table must already exist and can be
@@ -157,11 +164,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
157164
You can read the documentation for more details on API usage and use GitHub
158165
to `browse the source`_ and `report issues`_.
159166

160-
.. Google Cloud Client Library for Python:
167+
.. _Google Cloud Client Library for Python:
161168
https://googlecloudplatform.github.io/google-cloud-python/
162-
.. browse the source:
169+
.. _browse the source:
163170
https://github.com/GoogleCloudPlatform/google-cloud-python
164-
.. report issues:
171+
.. _report issues:
165172
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
166173

167174

‎speech/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,11 +170,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
170170
You can read the documentation for more details on API usage and use GitHub
171171
to `browse the source`_ and `report issues`_.
172172

173-
.. Google Cloud Client Library for Python:
173+
.. _Google Cloud Client Library for Python:
174174
https://googlecloudplatform.github.io/google-cloud-python/
175-
.. browse the source:
175+
.. _browse the source:
176176
https://github.com/GoogleCloudPlatform/google-cloud-python
177-
.. report issues:
177+
.. _report issues:
178178
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
179179

180180

‎storage/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,11 +278,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
278278
You can read the documentation for more details on API usage and use GitHub
279279
to `browse the source`_ and `report issues`_.
280280
281-
.. Google Cloud Client Library for Python:
281+
.. _Google Cloud Client Library for Python:
282282
https://googlecloudplatform.github.io/google-cloud-python/
283-
.. browse the source:
283+
.. _browse the source:
284284
https://github.com/GoogleCloudPlatform/google-cloud-python
285-
.. report issues:
285+
.. _report issues:
286286
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
287287
288288

‎translate/cloud-client/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,11 +130,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
130130
You can read the documentation for more details on API usage and use GitHub
131131
to `browse the source`_ and `report issues`_.
132132
133-
.. Google Cloud Client Library for Python:
133+
.. _Google Cloud Client Library for Python:
134134
https://googlecloudplatform.github.io/google-cloud-python/
135-
.. browse the source:
135+
.. _browse the source:
136136
https://github.com/GoogleCloudPlatform/google-cloud-python
137-
.. report issues:
137+
.. _report issues:
138138
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
139139
140140

‎video/cloud-client/analyze/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
115115
You can read the documentation for more details on API usage and use GitHub
116116
to `browse the source`_ and `report issues`_.
117117

118-
.. Google Cloud Client Library for Python:
118+
.. _Google Cloud Client Library for Python:
119119
https://googlecloudplatform.github.io/google-cloud-python/
120-
.. browse the source:
120+
.. _browse the source:
121121
https://github.com/GoogleCloudPlatform/google-cloud-python
122-
.. report issues:
122+
.. _report issues:
123123
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
124124

125125

‎video/cloud-client/faces/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
109109
You can read the documentation for more details on API usage and use GitHub
110110
to `browse the source`_ and `report issues`_.
111111

112-
.. Google Cloud Client Library for Python:
112+
.. _Google Cloud Client Library for Python:
113113
https://googlecloudplatform.github.io/google-cloud-python/
114-
.. browse the source:
114+
.. _browse the source:
115115
https://github.com/GoogleCloudPlatform/google-cloud-python
116-
.. report issues:
116+
.. _report issues:
117117
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
118118

119119

‎video/cloud-client/labels/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
109109
You can read the documentation for more details on API usage and use GitHub
110110
to `browse the source`_ and `report issues`_.
111111

112-
.. Google Cloud Client Library for Python:
112+
.. _Google Cloud Client Library for Python:
113113
https://googlecloudplatform.github.io/google-cloud-python/
114-
.. browse the source:
114+
.. _browse the source:
115115
https://github.com/GoogleCloudPlatform/google-cloud-python
116-
.. report issues:
116+
.. _report issues:
117117
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
118118

119119

‎video/cloud-client/shotchange/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
109109
You can read the documentation for more details on API usage and use GitHub
110110
to `browse the source`_ and `report issues`_.
111111

112-
.. Google Cloud Client Library for Python:
112+
.. _Google Cloud Client Library for Python:
113113
https://googlecloudplatform.github.io/google-cloud-python/
114-
.. browse the source:
114+
.. _browse the source:
115115
https://github.com/GoogleCloudPlatform/google-cloud-python
116-
.. report issues:
116+
.. _report issues:
117117
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
118118

119119

‎vision/cloud-client/crop_hints/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,11 @@ This sample uses the `Google Cloud Client Library for Python`_.
100100
You can read the documentation for more details on API usage and use GitHub
101101
to `browse the source`_ and `report issues`_.
102102
103-
.. Google Cloud Client Library for Python:
103+
.. _Google Cloud Client Library for Python:
104104
https://googlecloudplatform.github.io/google-cloud-python/
105-
.. browse the source:
105+
.. _browse the source:
106106
https://github.com/GoogleCloudPlatform/google-cloud-python
107-
.. report issues:
107+
.. _report issues:
108108
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
109109
110110

0 commit comments

Comments
 (0)