Skip to content

Commit 158af6c

Browse files
author
Jon Wayne Parrott
committed
Updating doc links (#324)
1 parent 2d930bb commit 158af6c

File tree

19 files changed

+396
-72
lines changed

19 files changed

+396
-72
lines changed

appengine/blobstore/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# App Engine Blobstore Sample
22

33
<!-- auto-doc-link -->
4-
These samples are used on the following documentation page:
4+
These samples are used on the following documentation pages:
55

6-
> https://cloud.google.com/appengine/docs/python/blobstore/
6+
>
7+
* https://cloud.google.com/appengine/docs/python/tools/webapp/blobstorehandlers
8+
* https://cloud.google.com/appengine/docs/python/blobstore/
79

810
<!-- end-auto-doc-link -->
911
-->

appengine/mail/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,14 @@ This sample application demonstrates different ways to send and receive email
44
on App Engine
55

66

7-
<!-- auto-doc-link --><!-- end-auto-doc-link -->
7+
<!-- auto-doc-link -->
8+
These samples are used on the following documentation pages:
9+
10+
>
11+
* https://cloud.google.com/appengine/docs/python/mail/headers
12+
* https://cloud.google.com/appengine/docs/python/mail/receiving-mail-with-mail-api
13+
* https://cloud.google.com/appengine/docs/python/mail/sending-mail-with-mail-api
14+
* https://cloud.google.com/appengine/docs/python/mail/attachments
15+
* https://cloud.google.com/appengine/docs/python/mail/bounce
16+
17+
<!-- end-auto-doc-link -->

appengine/memcache/guestbook/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ This is a sample app for Google App Engine that demonstrates the Memcache Python
55
<!-- auto-doc-link -->
66
These samples are used on the following documentation page:
77

8-
> https://cloud.google.com/appengine/docs/python/memcache/usingmemcache
8+
> https://cloud.google.com/appengine/docs/python/memcache/examples
99
1010
<!-- end-auto-doc-link -->
1111

1212
Refer to the [App Engine Samples README](../../README.md) for information on how to run and deploy this sample.
13+
ple.

appengine/ndb/entities/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@ This contains snippets used in the NDB entity documentation, demonstrating
44
various operations on ndb entities.
55

66
<!-- auto-doc-link -->
7-
These samples are used on the following documentation page:
7+
These samples are used on the following documentation pages:
88

9-
> https://cloud.google.com/appengine/docs/python/ndb/entities
9+
>
10+
* https://cloud.google.com/appengine/docs/python/datastore/creating-entities
11+
* https://cloud.google.com/appengine/docs/python/datastore/creating-entity-models
12+
* https://cloud.google.com/appengine/docs/python/users/userobjects
13+
* https://cloud.google.com/appengine/docs/python/datastore/creating-entity-keys
1014

1115
<!-- end-auto-doc-link -->

appengine/ndb/projection_queries/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ demonstrating various ways to make ndb projection queries.
66
<!-- auto-doc-link -->
77
These samples are used on the following documentation page:
88

9-
> https://cloud.google.com/appengine/docs/python/ndb/projectionqueries
9+
> https://cloud.google.com/appengine/docs/python/datastore/projectionqueries
1010
1111
<!-- end-auto-doc-link -->

appengine/ndb/properties/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ various operations on ndb properties.
66
<!-- auto-doc-link -->
77
These samples are used on the following documentation page:
88

9-
> https://cloud.google.com/appengine/docs/python/ndb/properties
9+
> https://cloud.google.com/appengine/docs/python/datastore/entity-property-reference
1010
1111
<!-- end-auto-doc-link -->

appengine/requests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ These snippets demonstrate various aspects of App Engine Python request handling
55
<!-- auto-doc-link -->
66
These samples are used on the following documentation page:
77

8-
> https://cloud.google.com/appengine/docs/python/requests
8+
> https://cloud.google.com/appengine/docs/python/how-requests-are-handled
99
1010
<!-- end-auto-doc-link -->

appengine/taskqueue/counter/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ To deploy this application, specify both `.yaml` files to `appcfg.py`:
99
appcfg.py update -A your-app-id -V 1 application.yaml worker.yaml
1010

1111
<!-- auto-doc-link -->
12-
These samples are used on the following documentation page:
12+
These samples are used on the following documentation pages:
1313

14-
> https://cloud.google.com/appengine/docs/python/taskqueue/overview-push
14+
>
15+
* https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers
16+
* https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-tasks
1517

1618
<!-- end-auto-doc-link -->

appengine/xmpp/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
This sample includes snippets used in the [App Engine XMPP Docs](https://cloud.google.com/appengine/docs/python/xmpp/).
44

55
<!-- auto-doc-link -->
6+
These samples are used on the following documentation page:
67

8+
> https://cloud.google.com/appengine/docs/python/xmpp/
79
810
<!-- end-auto-doc-link -->

bigquery/api/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
These samples are used on the following documentation pages:
55

66
>
7-
* https://cloud.google.com/bigquery/exporting-data-from-bigquery
7+
* https://cloud.google.com/bigquery/docs/loading-data-cloud-storage
8+
* https://cloud.google.com/bigquery/create-simple-app-api
9+
* https://cloud.google.com/bigquery/loading-data-post-request
810
* https://cloud.google.com/bigquery/authentication
11+
* https://cloud.google.com/bigquery/exporting-data-from-bigquery
912
* https://cloud.google.com/bigquery/bigquery-api-quickstart
1013
* https://cloud.google.com/bigquery/docs/managing_jobs_datasets_projects
1114
* https://cloud.google.com/bigquery/streaming-data-into-bigquery
1215
* https://cloud.google.com/bigquery/docs/data
1316
* https://cloud.google.com/bigquery/querying-data
14-
* https://cloud.google.com/bigquery/loading-data-into-bigquery
1517

1618
<!-- end-auto-doc-link -->

compute/api/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Compute Engine API Samples
22

33
<!-- auto-doc-link -->
4-
These samples are used on the following documentation page:
4+
These samples are used on the following documentation pages:
55

6-
> https://cloud.google.com/compute/docs/tutorials/python-guide
6+
>
7+
* https://cloud.google.com/compute/docs/tutorials/python-guide
8+
* https://cloud.google.com/compute/docs/instances/create-start-instance
9+
* https://cloud.google.com/compute/docs/api/how-tos/api-requests-responses
710

811
<!-- end-auto-doc-link -->
912

compute/metadata/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,8 @@
33
These samples demonstrate interacting with the Compute Engine metadata service. These samples must be run on Compute Engine.
44

55
<!-- auto-doc-link -->
6+
These samples are used on the following documentation page:
7+
8+
> https://cloud.google.com/compute/docs/metadata
9+
610
<!-- end-auto-doc-link -->

dns/api/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# Cloud DNS API Samples
22

33
<!-- auto-doc-link -->
4+
These samples are used on the following documentation pages:
5+
6+
>
7+
* https://cloud.google.com/dns/records/
8+
* https://cloud.google.com/dns/zones/
9+
* https://cloud.google.com/dns/monitoring
10+
411
<!-- end-auto-doc-link -->

error_reporting/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,8 @@ Then,
2323
And you will see the message in the Errors Console.
2424

2525
<!-- auto-doc-link -->
26+
These samples are used on the following documentation page:
27+
28+
> https://cloud.google.com/error-reporting/docs/setting-up-on-compute-engine
2629
2730
<!-- end-auto-doc-link -->

monitoring/api/v2/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Cloud Monitoring API Samples
22

33
<!-- auto-doc-link -->
4-
These samples are used on the following documentation pages:
4+
These samples are used on the following documentation page:
55

6-
>
7-
* https://cloud.google.com/monitoring/demos/
8-
* https://cloud.google.com/monitoring/api/authentication
6+
> https://cloud.google.com/monitoring/demos/
7+
8+
<!-- end-auto-doc-link -->
9+
m/monitoring/api/authentication
910

1011
<!-- end-auto-doc-link -->

scripts/auto_link_to_docs.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,8 @@ def update_readme(readme_path, docs):
133133

134134
def main():
135135
docs_links = json.load(open(
136-
os.path.join(REPO_ROOT, 'scripts', 'docs-links.json'), 'r'))
136+
os.path.join(
137+
REPO_ROOT, 'scripts', 'resources', 'docs-links.json'), 'r'))
137138
files_to_docs = invert_docs_link_map(docs_links)
138139
readmes_to_docs = collect_docs_for_readmes(files_to_docs)
139140

0 commit comments

Comments
 (0)