docs: Pysamples new readme gen #112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
google-cla
bot
added
the
cla: yes
kolea2
requested changes
Aug 20, 2020
kolea2
reviewed
Aug 20, 2020
product-auto-label
bot
added
the
api: bigtable
kolea2
reviewed
Aug 21, 2020
|
|
||
| usage: main.py [-h] [--table TABLE] project_id instance_id | ||
|
|
||
| Demonstrates how to connect to Cloud Bigtable and run some basic operations. |
There was a problem hiding this comment.
it looks like this bit is no longer in the readme. is this intentional?
kolea2
requested changes
Aug 21, 2020
samples/beam/README.md
Outdated
| Samples, quickstarts, and other documentation are available at <a href="https://cloud.google.com/bigtable">cloud.google.com</a>. | ||
|
|
||
|
|
||
| ### Beam |
There was a problem hiding this comment.
doesn't seem to have any instructions?
kolea2
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
kolea2
reviewed
Aug 21, 2020
.repo-metadata.json
Outdated
| "description": "This page explains how to use the cbt command to connect to a Cloud Bigtable instance, perform basic administrative tasks, and read and write data in a table. More information about this quickstart is available at https://cloud.google.com/bigtable/docs/quickstart-cbt", | ||
| "file": "instanceadmin.py", | ||
| "runnable": true, | ||
| "custom_content" : "<pre><br>Demonstrates how to connect to Cloud Bigtable and run some basic operations.<br>Prerequisites: - Create a Cloud Bigtable cluster.<br>https://cloud.google.com/bigtable/docs/creating-cluster - Set your Google<br>Application Default Credentials.<br>https://developers.google.com/identity/protocols/application-default-<br>credentials<br><br><br>positional arguments:<br> project_id Your Cloud Platform project ID.<br> instance_id ID of the Cloud Bigtable instance to connect to.<br><br><br>optional arguments:<br> -h, --help show this help message and exit<br> --table TABLE Table to create and destroy. (default: Hello-Bigtable)</pre>", |
…bigtable into pysamples-new-README-gen
kolea2
approved these changes
Aug 21, 2020
kolea2
added
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds some new generation code to the synth.py to handle generation of the Python sample docs! Content of the sample descriptions/custom content is predominantly pulled from the existing docs