Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating doc links #324

Merged
merged 1 commit into from
May 4, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions appengine/blobstore/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# App Engine Blobstore Sample

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

> https://cloud.google.com/appengine/docs/python/blobstore/
>
* https://cloud.google.com/appengine/docs/python/tools/webapp/blobstorehandlers
* https://cloud.google.com/appengine/docs/python/blobstore/

<!-- end-auto-doc-link -->
-->
12 changes: 11 additions & 1 deletion appengine/mail/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,14 @@ This sample application demonstrates different ways to send and receive email
on App Engine


<!-- auto-doc-link --><!-- end-auto-doc-link -->
<!-- auto-doc-link -->
These samples are used on the following documentation pages:

>
* https://cloud.google.com/appengine/docs/python/mail/headers
* https://cloud.google.com/appengine/docs/python/mail/receiving-mail-with-mail-api
* https://cloud.google.com/appengine/docs/python/mail/sending-mail-with-mail-api
* https://cloud.google.com/appengine/docs/python/mail/attachments
* https://cloud.google.com/appengine/docs/python/mail/bounce

<!-- end-auto-doc-link -->
3 changes: 2 additions & 1 deletion appengine/memcache/guestbook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ This is a sample app for Google App Engine that demonstrates the Memcache Python
<!-- auto-doc-link -->
These samples are used on the following documentation page:

> https://cloud.google.com/appengine/docs/python/memcache/usingmemcache
> https://cloud.google.com/appengine/docs/python/memcache/examples

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

Refer to the [App Engine Samples README](../../README.md) for information on how to run and deploy this sample.
ple.
8 changes: 6 additions & 2 deletions appengine/ndb/entities/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ This contains snippets used in the NDB entity documentation, demonstrating
various operations on ndb entities.

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

> https://cloud.google.com/appengine/docs/python/ndb/entities
>
* https://cloud.google.com/appengine/docs/python/datastore/creating-entities
* https://cloud.google.com/appengine/docs/python/datastore/creating-entity-models
* https://cloud.google.com/appengine/docs/python/users/userobjects
* https://cloud.google.com/appengine/docs/python/datastore/creating-entity-keys

<!-- end-auto-doc-link -->
2 changes: 1 addition & 1 deletion appengine/ndb/projection_queries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ demonstrating various ways to make ndb projection queries.
<!-- auto-doc-link -->
These samples are used on the following documentation page:

> https://cloud.google.com/appengine/docs/python/ndb/projectionqueries
> https://cloud.google.com/appengine/docs/python/datastore/projectionqueries

<!-- end-auto-doc-link -->
2 changes: 1 addition & 1 deletion appengine/ndb/properties/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ various operations on ndb properties.
<!-- auto-doc-link -->
These samples are used on the following documentation page:

> https://cloud.google.com/appengine/docs/python/ndb/properties
> https://cloud.google.com/appengine/docs/python/datastore/entity-property-reference

<!-- end-auto-doc-link -->
2 changes: 1 addition & 1 deletion appengine/requests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ These snippets demonstrate various aspects of App Engine Python request handling
<!-- auto-doc-link -->
These samples are used on the following documentation page:

> https://cloud.google.com/appengine/docs/python/requests
> https://cloud.google.com/appengine/docs/python/how-requests-are-handled

<!-- end-auto-doc-link -->
6 changes: 4 additions & 2 deletions appengine/taskqueue/counter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ To deploy this application, specify both `.yaml` files to `appcfg.py`:
appcfg.py update -A your-app-id -V 1 application.yaml worker.yaml

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

> https://cloud.google.com/appengine/docs/python/taskqueue/overview-push
>
* https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers
* https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-tasks

<!-- end-auto-doc-link -->
2 changes: 2 additions & 0 deletions appengine/xmpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
This sample includes snippets used in the [App Engine XMPP Docs](https://cloud.google.com/appengine/docs/python/xmpp/).

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

> https://cloud.google.com/appengine/docs/python/xmpp/

<!-- end-auto-doc-link -->
6 changes: 4 additions & 2 deletions bigquery/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@
These samples are used on the following documentation pages:

>
* https://cloud.google.com/bigquery/exporting-data-from-bigquery
* https://cloud.google.com/bigquery/docs/loading-data-cloud-storage
* https://cloud.google.com/bigquery/create-simple-app-api
* https://cloud.google.com/bigquery/loading-data-post-request
* https://cloud.google.com/bigquery/authentication
* https://cloud.google.com/bigquery/exporting-data-from-bigquery
* https://cloud.google.com/bigquery/bigquery-api-quickstart
* https://cloud.google.com/bigquery/docs/managing_jobs_datasets_projects
* https://cloud.google.com/bigquery/streaming-data-into-bigquery
* https://cloud.google.com/bigquery/docs/data
* https://cloud.google.com/bigquery/querying-data
* https://cloud.google.com/bigquery/loading-data-into-bigquery

<!-- end-auto-doc-link -->
7 changes: 5 additions & 2 deletions compute/api/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Compute Engine API Samples

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

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

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

Expand Down
4 changes: 4 additions & 0 deletions compute/metadata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,8 @@
These samples demonstrate interacting with the Compute Engine metadata service. These samples must be run on Compute Engine.

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

> https://cloud.google.com/compute/docs/metadata

<!-- end-auto-doc-link -->
7 changes: 7 additions & 0 deletions dns/api/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Cloud DNS API Samples

<!-- auto-doc-link -->
These samples are used on the following documentation pages:

>
* https://cloud.google.com/dns/records/
* https://cloud.google.com/dns/zones/
* https://cloud.google.com/dns/monitoring

<!-- end-auto-doc-link -->
3 changes: 3 additions & 0 deletions error_reporting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,8 @@ Then,
And you will see the message in the Errors Console.

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

> https://cloud.google.com/error-reporting/docs/setting-up-on-compute-engine

<!-- end-auto-doc-link -->
9 changes: 5 additions & 4 deletions monitoring/api/v2/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Cloud Monitoring API Samples

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

>
* https://cloud.google.com/monitoring/demos/
* https://cloud.google.com/monitoring/api/authentication
> https://cloud.google.com/monitoring/demos/

<!-- end-auto-doc-link -->
m/monitoring/api/authentication

<!-- end-auto-doc-link -->
3 changes: 2 additions & 1 deletion scripts/auto_link_to_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ def update_readme(readme_path, docs):

def main():
docs_links = json.load(open(
os.path.join(REPO_ROOT, 'scripts', 'docs-links.json'), 'r'))
os.path.join(
REPO_ROOT, 'scripts', 'resources', 'docs-links.json'), 'r'))
files_to_docs = invert_docs_link_map(docs_links)
readmes_to_docs = collect_docs_for_readmes(files_to_docs)

Expand Down
Loading