Added "Open in Cloud Shell" buttons to README files [(#1254)](GoogleC…

…loudPlatform/python-docs-samples#1254)
busunkim96 · Dec 7, 2017 · f2adc97 · f2adc97
1 parent 334ff74
commit f2adc97
Show file tree

Hide file tree

Showing 12 changed files with 81 additions and 16 deletions.
diff --git a/samples/snippets/crop_hints/README.rst b/samples/snippets/crop_hints/README.rst
@@ -3,6 +3,10 @@
 Google Cloud Vision API 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=vision/cloud-client/crop_hints/README.rst
+
+
 This directory contains samples for Google Cloud Vision API. `Google Cloud Vision API`_ allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
 - See the `migration guide`_ for information about migrating to Python client library v0.25.1.
@@ -58,6 +62,10 @@ Samples
 Crop Hints Tutorial
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+.. 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=vision/cloud-client/crop_hints/crop_hints.py;vision/cloud-client/crop_hints/README.rst
+
+
 
 
 To run this sample:
@@ -67,17 +75,18 @@ To run this sample:
     $ python crop_hints.py
 
     usage: crop_hints.py [-h] image_file mode
-    
+
     positional arguments:
       image_file  The image you'd like to crop.
       mode        Set to "crop" or "draw".
-    
+
     optional arguments:
       -h, --help  show this help message and exit
 
 
 
 
+
 The client library
 -------------------------------------------------------------------------------
 

diff --git a/samples/snippets/crop_hints/README.rst.in b/samples/snippets/crop_hints/README.rst.in
@@ -26,3 +26,5 @@ samples:
   show_help: True
 
 cloud_client_library: true
+
+folder: vision/cloud-client/crop_hints
diff --git a/samples/snippets/detect/README.rst b/samples/snippets/detect/README.rst
@@ -3,6 +3,10 @@
 Google Cloud Vision API 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=vision/cloud-client/detect/README.rst
+
+
 This directory contains samples for Google Cloud Vision API. `Google Cloud Vision API`_ allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
 - See the `migration guide`_ for information about migrating to Python client library v0.25.1.
@@ -58,6 +62,10 @@ Samples
 Detect
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+.. 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=vision/cloud-client/detect/detect.py;vision/cloud-client/detect/README.rst
+
+
 
 
 To run this sample:
@@ -69,20 +77,20 @@ To run this sample:
     usage: detect.py [-h]
                      {faces,faces-uri,labels,labels-uri,landmarks,landmarks-uri,text,text-uri,logos,logos-uri,safe-search,safe-search-uri,properties,properties-uri,web,web-uri,crophints,crophints-uri,document,document-uri}
                      ...
-    
+
     This application demonstrates how to perform basic operations with the
     Google Cloud Vision API.
-    
+
     Example Usage:
     python detect.py text ./resources/wakeupcat.jpg
     python detect.py labels ./resources/landmark.jpg
     python detect.py web ./resources/landmark.jpg
     python detect.py web-uri http://wheresgus.com/dog.JPG
     python detect.py faces-uri gs://your-bucket/file.jpg
-    
+
     For more information, the documentation at
     https://cloud.google.com/vision/docs.
-    
+
     positional arguments:
       {faces,faces-uri,labels,labels-uri,landmarks,landmarks-uri,text,text-uri,logos,logos-uri,safe-search,safe-search-uri,properties,properties-uri,web,web-uri,crophints,crophints-uri,document,document-uri}
         faces               Detects faces in an image.
@@ -115,13 +123,14 @@ To run this sample:
         document            Detects document features in an image.
         document-uri        Detects document features in the file located in
                             Google Cloud Storage.
-    
+
     optional arguments:
       -h, --help            show this help message and exit
 
 
 
 
+
 The client library
 -------------------------------------------------------------------------------
 

diff --git a/samples/snippets/detect/README.rst.in b/samples/snippets/detect/README.rst.in
@@ -26,3 +26,5 @@ samples:
   show_help: True
 
 cloud_client_library: true
+
+folder: vision/cloud-client/detect
diff --git a/samples/snippets/document_text/README.rst b/samples/snippets/document_text/README.rst
@@ -3,6 +3,10 @@
 Google Cloud Vision API 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=vision/cloud-client/document_text/README.rst
+
+
 This directory contains samples for Google Cloud Vision API. `Google Cloud Vision API`_ allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
 - See the `migration guide`_ for information about migrating to Python client library v0.25.1.
@@ -58,6 +62,10 @@ Samples
 Document Text tutorial
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+.. 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=vision/cloud-client/document_text/doctext.py;vision/cloud-client/document_text/README.rst
+
+
 
 
 To run this sample:
@@ -67,17 +75,18 @@ To run this sample:
     $ python doctext.py
 
     usage: doctext.py [-h] [-out_file OUT_FILE] detect_file
-    
+
     positional arguments:
       detect_file         The image for text detection.
-    
+
     optional arguments:
       -h, --help          show this help message and exit
       -out_file OUT_FILE  Optional output file
 
 
 
 
+
 The client library
 -------------------------------------------------------------------------------
 

diff --git a/samples/snippets/document_text/README.rst.in b/samples/snippets/document_text/README.rst.in
@@ -26,3 +26,5 @@ samples:
   show_help: True
 
 cloud_client_library: true
+
+folder: vision/cloud-client/document_text
diff --git a/samples/snippets/face_detection/README.rst b/samples/snippets/face_detection/README.rst
@@ -3,6 +3,10 @@
 Google Cloud Vision API 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=vision/cloud-client/face_detection/README.rst
+
+
 This directory contains samples for Google Cloud Vision API. `Google Cloud Vision API`_ allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
 - See the `migration guide`_ for information about migrating to Python client library v0.25.1.
@@ -59,6 +63,10 @@ Samples
 Face detection
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+.. 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=vision/cloud-client/face_detection/faces.py;vision/cloud-client/face_detection/README.rst
+
+
 
 
 To run this sample:
@@ -68,12 +76,12 @@ To run this sample:
     $ python faces.py
 
     usage: faces.py [-h] [--out OUTPUT] [--max-results MAX_RESULTS] input_image
-    
+
     Detects faces in the given image.
-    
+
     positional arguments:
       input_image           the image you'd like to detect faces in.
-    
+
     optional arguments:
       -h, --help            show this help message and exit
       --out OUTPUT          the name of the output file.
@@ -83,4 +91,5 @@ To run this sample:
 
 
 
+
 .. _Google Cloud SDK: https://cloud.google.com/sdk/
diff --git a/samples/snippets/face_detection/README.rst.in b/samples/snippets/face_detection/README.rst.in
@@ -27,3 +27,5 @@ samples:
 - name: Face detection
   file: faces.py
   show_help: true
+
+folder: vision/cloud-client/face_detection
diff --git a/samples/snippets/quickstart/README.rst b/samples/snippets/quickstart/README.rst
@@ -3,6 +3,10 @@
 Google Cloud Vision API 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=vision/cloud-client/quickstart/README.rst
+
+
 This directory contains samples for Google Cloud Vision API. `Google Cloud Vision API`_ allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
 - See the `migration guide`_ for information about migrating to Python client library v0.25.1.
@@ -58,6 +62,10 @@ Samples
 Quickstart
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+.. 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=vision/cloud-client/quickstart/quickstart.py;vision/cloud-client/quickstart/README.rst
+
+
 
 
 To run this sample:

diff --git a/samples/snippets/quickstart/README.rst.in b/samples/snippets/quickstart/README.rst.in
@@ -25,3 +25,5 @@ samples:
   file: quickstart.py
 
 cloud_client_library: true
+
+folder: vision/cloud-client/quickstart
diff --git a/samples/snippets/web/README.rst b/samples/snippets/web/README.rst
@@ -3,6 +3,10 @@
 Google Cloud Vision API 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=vision/cloud-client/web/README.rst
+
+
 This directory contains samples for Google Cloud Vision API. `Google Cloud Vision API`_ allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
 - See the `migration guide`_ for information about migrating to Python client library v0.25.1.
@@ -58,6 +62,10 @@ Samples
 Web
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+.. 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=vision/cloud-client/web/web_detect.py;vision/cloud-client/web/README.rst
+
+
 
 
 To run this sample:
@@ -67,24 +75,25 @@ To run this sample:
     $ python web_detect.py
 
     usage: web_detect.py [-h] image_url
-    
+
     Demonstrates web detection using the Google Cloud Vision API.
-    
+
     Example usage:
       python web_detect.py https://goo.gl/X4qcB6
       python web_detect.py ../detect/resources/landmark.jpg
       python web_detect.py gs://your-bucket/image.png
-    
+
     positional arguments:
       image_url   The image to detect, can be web URI, Google Cloud Storage, or
                   path to local file.
-    
+
     optional arguments:
       -h, --help  show this help message and exit
 
 
 
 
+
 The client library
 -------------------------------------------------------------------------------
 

diff --git a/samples/snippets/web/README.rst.in b/samples/snippets/web/README.rst.in
@@ -26,3 +26,5 @@ samples:
   show_help: True
 
 cloud_client_library: true
+
+folder: vision/cloud-client/web