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.

Sign up for GitHub

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

Trivial fix to Cloud IoT URL. #1302

Merged
merged 1 commit into from
Jan 16, 2018
Merged

Trivial fix to Cloud IoT URL. #1302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions iot/api-client/end_to_end_example/README.rst.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This file is used to generate README.rst

product:
name: Google Cloud IoT Core API
name: Google Cloud IoT Core
short_name: Cloud IoT Core
url: https://cloud.google.com/iot/docs
description: >
Expand All @@ -10,8 +10,8 @@ product:
authorization.

Before you run the sample, you must retrieve the Google root certificate.
For example, `wget https://pki.goog/roots.pem` or
`curl https://pki.goog/roots.pem > roots.pem`.
For example, ``wget https://pki.goog/roots.pem`` or
``curl https://pki.goog/roots.pem > roots.pem``.

setup:
- auth
Expand Down
8 changes: 4 additions & 4 deletions iot/api-client/http_example/README.rst.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# This file is used to generate README.rst

product:
name: Google Cloud IoT Core API
name: Google Cloud IoT Core
short_name: Cloud IoT Core
url: https://cloud.google.com/iot/docs
description: >
`Google Cloud IoT Core`_ allows developers to easily integrate Publish and
Subscribe functionality with devices and programmatically manage device
authorization.

The following example runs the sample using the project ID `blue-jet-123`
and the device name `my-python-device`:
The following example runs the sample using the project ID ``blue-jet-123``
and the device name ``my-python-device``::

python cloudiot_http_example.py \
--registry_id=my-registry \
Expand All @@ -30,4 +30,4 @@ samples:

cloud_client_library: false

folder: iot/api-client/http_example
folder: iot/api-client/http_example
38 changes: 22 additions & 16 deletions iot/api-client/manager/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.. This file is automatically generated. Do not edit this file directly.

Google Cloud IoT Core API Python Samples
Google Cloud IoT Core Python Samples
===============================================================================

.. image:: https://gstatic.com/cloudssh/images/open-btn.png
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=iot/api-client/manager/README.rst


This directory contains samples for Google Cloud IoT Core API. `Google Cloud IoT Core`_ allows developers to easily integrate Publish and Subscribe functionality with devices and programmatically manage device authorization.
This directory contains samples for Google Cloud IoT Core. `Google Cloud IoT Core`_ allows developers to easily integrate Publish and Subscribe functionality with devices and programmatically manage device authorization.




.. _Google Cloud IoT Core API: https://cloud.google.com/vision/docs
.. _Google Cloud IoT Core: https://cloud.google.com/iot/docs

Setup
-------------------------------------------------------------------------------
Expand Down Expand Up @@ -70,13 +70,15 @@ To run this sample:

$ python manager.py

usage: manager.py [-h] --pubsub_topic PUBSUB_TOPIC [--project_id PROJECT_ID]
usage: manager.py [-h] --pubsub_topic PUBSUB_TOPIC
[--cloud_region CLOUD_REGION] [--config CONFIG]
[--device_id DEVICE_ID]
[--ec_public_key_file EC_PUBLIC_KEY_FILE]
[--project_id PROJECT_ID] [--registry_id REGISTRY_ID]
[--rsa_certificate_file RSA_CERTIFICATE_FILE]
[--cloud_region CLOUD_REGION]
[--service_account_json SERVICE_ACCOUNT_JSON]
[--registry_id REGISTRY_ID] [--device_id DEVICE_ID]
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256}
[--version VERSION]
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256,set-config}
...

Example of using the Google Cloud IoT Core device manager to administer
Expand All @@ -93,7 +95,7 @@ To run this sample:
list

positional arguments:
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256}
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256,set-config}
create-es256 Create a new device with the given id, using ES256 for
authentication.
create-registry Gets or creates a device registry.
Expand All @@ -113,26 +115,30 @@ To run this sample:
device.
patch-rs256 Patch the device to add an RSA256 public key to the
device.
set-config Patch the device to add an RSA256 public key to the
device.

optional arguments:
-h, --help show this help message and exit
--pubsub_topic PUBSUB_TOPIC
Google Cloud Pub/Sub topic. Format is
projects/project_id/topics/topic-id
--project_id PROJECT_ID
GCP cloud project name.
--cloud_region CLOUD_REGION
GCP cloud region
--config CONFIG Configuration sent to a device.
--device_id DEVICE_ID
Device id.
--ec_public_key_file EC_PUBLIC_KEY_FILE
Path to public ES256 key file.
--project_id PROJECT_ID
GCP cloud project name.
--registry_id REGISTRY_ID
Registry id. If not set, a name will be generated.
--rsa_certificate_file RSA_CERTIFICATE_FILE
Path to RS256 certificate file.
--cloud_region CLOUD_REGION
GCP cloud region
--service_account_json SERVICE_ACCOUNT_JSON
Path to service account json file.
--registry_id REGISTRY_ID
Registry id. If not set, a name will be generated.
--device_id DEVICE_ID
Device id.
--version VERSION Version number for setting device configuration.



Expand Down
6 changes: 3 additions & 3 deletions iot/api-client/manager/README.rst.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# This file is used to generate README.rst

product:
name: Google Cloud IoT Core API
name: Google Cloud IoT Core
short_name: Cloud IoT Core
url: https://cloud.google.com/vision/docs
url: https://cloud.google.com/iot/docs
description: >
`Google Cloud IoT Core`_ allows developers to easily integrate Publish and
Subscribe functionality with devices and programmatically manage device
Expand All @@ -20,4 +20,4 @@ samples:

cloud_client_library: false

folder: iot/api-client/manager
folder: iot/api-client/manager
12 changes: 6 additions & 6 deletions iot/api-client/mqtt_example/README.rst.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This file is used to generate README.rst

product:
name: Google Cloud IoT Core API
name: Google Cloud IoT Core
short_name: Cloud IoT Core
url: https://cloud.google.com/iot/docs
description: >
Expand All @@ -10,11 +10,11 @@ product:
authorization.

Before you run the sample, you must retrieve the Google root certificate.
For example, `wget https://pki.goog/roots.pem` or
`curl https://pki.goog/roots.pem > roots.pem`.
For example, ``wget https://pki.goog/roots.pem`` or
``curl https://pki.goog/roots.pem > roots.pem``.

The following example runs the sample using the project ID `blue-jet-123`
and the device name `my-python-device`:
The following example runs the sample using the project ID ``blue-jet-123``
and the device name ``my-python-device``::

python cloudiot_mqtt_example.py \
--registry_id=my-registry \
Expand All @@ -33,4 +33,4 @@ samples:

cloud_client_library: false

folder: iot/api-client/mqtt_example
folder: iot/api-client/mqtt_example
6 changes: 3 additions & 3 deletions iot/api-client/scripts/README.rst.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
product:
name: Google Cloud IoT Core
short_name: Cloud IoT Core
url: https://cloud.google.com/iot/
url: https://cloud.google.com/iot/docs
description: >
`Google Cloud IoT Core`_ is a fully-managed, globally distributed solution
for managing devices and sending / receiving messages from devices. Set the
`GOOGLE_CLOUD_PROJECT` environment variable and call the script with your
``GOOGLE_CLOUD_PROJECT`` environment variable and call the script with your
topic ID.

setup:
Expand All @@ -21,4 +21,4 @@ samples:

cloud_client_library: true

folder: iot/api-client/scripts
folder: iot/api-client/scripts
2 changes: 1 addition & 1 deletion scripts/readme-gen/templates/README.tmpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This directory contains samples for {{product.name}}. {{product.description}}

{{description}}

.. _{{product.name}}: {{product.url}}
.. _{{product.name}}: {{product.url}}

{% if setup %}
Setup
Expand Down