doc(bigtable): revamp examples README#6839
Conversation
google-cla
Bot
added
the
cla: yes
product-auto-label
Bot
added
the
api: bigtable
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
Codecov Report
@@ Coverage Diff @@
## main #6839 +/- ##
==========================================
- Coverage 95.03% 95.03% -0.01%
==========================================
Files 1264 1264
Lines 113312 113312
==========================================
- Hits 107691 107685 -6
- Misses 5621 5627 +6
Continue to review full report at Codecov.
|
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
| @@ -1,208 +1,143 @@ | |||
| # Cloud Bigtable C++ Client Quick Start Code Samples | |||
There was a problem hiding this comment.
You need some kind of H1 type title, no?
| After configuring gRPC, you can run the examples using: | ||
| | Target | Description | | ||
| | ---------------------------------------- | ----------------------------------- | | ||
| | `./bigtable_hello_table_admin` | Demonstration of basic operations | |
There was a problem hiding this comment.
s/Demonstration/Demonstrates/ maybe?
| ## Credentials | ||
|
|
||
| This sample showcases reading and writing operations: | ||
| The following samples demonstrate use of [Authentication](https://cloud.google.com/bigtable/docs/authentication) and [Access Control]((https://cloud.google.com/bigtable/docs/access-control)) for Bigtable. More details on the samples can be found [here](https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-samples-grpc-credentials.html). |
There was a problem hiding this comment.
For long links like these consider using reference style links
dbolduc
left a comment
dbolduc
left a comment
There was a problem hiding this comment.
Reviewable status: 0 of 2 files reviewed, 2 unresolved discussions (waiting on @coryan)
google/cloud/bigtable/examples/README.md, line 98 at r2 (raw file):
Previously, coryan (Carlos O'Ryan) wrote…
s/Demonstration/Demonstrates/ maybe?
I think what I have is clunky. But it is self-consistent. The descriptions all say what the code is (not what the code does).
I am going to leave it as it is, but perhaps this is evidence that a table was not the best data structure
google/cloud/bigtable/examples/README.md, line 127 at r2 (raw file):
Previously, coryan (Carlos O'Ryan) wrote…
For long links like these consider using reference style links
Fixed.
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
3 participants
Fixes #6818
This change is