add header, use reference links

dbolduc · dbolduc · commit abada1bea66d · 2021-06-23T00:56:24.000-04:00
diff --git a/google/cloud/bigtable/examples/README.md b/google/cloud/bigtable/examples/README.md
@@ -1,3 +1,5 @@
+# Google Cloud Bigtable Code Samples
+
 ## Table of Contents
 
 - [Before you begin](#before-you-begin)
@@ -17,7 +19,7 @@
 
 You will need a Google Cloud Platform (GCP) Project with billing and the
 Bigtable Admin API enabled. The
-[Cloud Bigtable quickstart](https://cloud.google.com/bigtable/docs/quickstart-cbt)
+[Cloud Bigtable quickstart][cbt-doc-quickstart]
 covers the necessary steps in detail. Make a note of the GCP Project ID,
 Instance ID, and Table ID as you will need them below.
 
@@ -51,9 +53,9 @@ set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
 
 ## Hello World
 
-View the [Hello World][hello_world_code] example to see sample usage of the
+View the [Hello World][hello-world-code] example to see sample usage of the
 Bigtable client library. More details on this sample code can be found
-[here](https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-hello-world.html).
+[here][doxygen-hello-world].
 
 ### Running Hello World
 
@@ -65,16 +67,16 @@ $ ./bigtable_hello_world hello-world <project_id> <instance_id> <table_id>
 
 ### Hello World - `InstanceAdmin`
 
-View the [Hello Instance Admin][instance_admin_code] example to see sample usage of instance
+View the [Hello Instance Admin][instance-admin-code] example to see sample usage of instance
 administration of the Bigtable client library. More details on this sample code can be found
-[here](https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-hello-instance-admin.html).
+[here][doxygen-instance-admin].
 
 ### Running `InstanceAdmin` Samples
 
 | Target                               | Description                         |
 | ------------------------------------ | ----------------------------------- |
 | `./bigtable_hello_instance_admin`    | Demonstration of basic operations   |
-| `./bigtable_hello_app_profile`       | Demonstration of basic operations using [App Profile](https://cloud.google.com/bigtable/docs/app-profiles) |
+| `./bigtable_hello_app_profile`       | Demonstration of basic operations using [App Profile][cbt-doc-app-profiles] |
 | `./bigtable_instance_admin_snippets` | Collection of individual operations |
 
 Run the above targets with the `--help` flag to display the available commands and their usage.
@@ -88,16 +90,16 @@ $ ./bigtable_instance_admin_snippets create-instance <project-id> <instance-id>
 
 ### Hello World - `TableAdmin`
 
-View the [Hello Table Admin][table_admin_code] example to see sample usage of table
-administration of the Bigtable client library. More details on this sample code can be found [here](https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-hello-table-admin.html).
+View the [Hello Table Admin][table-admin-code] example to see sample usage of table
+administration of the Bigtable client library. More details on this sample code can be found [here][doxygen-table-admin].
 
 ### Running `TableAdmin` Samples
 
 | Target                                   | Description                         |
 | ---------------------------------------- | ----------------------------------- |
 | `./bigtable_hello_table_admin`           | Demonstration of basic operations   |
 | `./table_admin_snippets`                 | Collection of individual operations |
-| `./bigtable_table_admin_backup_snippets` | Collection of [Backup](https://cloud.google.com/bigtable/docs/backups) operations |
+| `./bigtable_table_admin_backup_snippets` | Collection of [Backup][cbt-doc-backups] operations |
 
 Run the above targets with the `--help` flag to display the available commands and their usage.
 Here is an example of one such command which will create a table.
@@ -112,7 +114,7 @@ $ ./table_admin_snippets create-table <project-id> <instance-id> <table-id>
 | `./read_snippets`        | Collection of synchronous read operations        |
 | `./data_snippets`        | Collection of other synchronous table operations |
 | `./data_async_snippets`  | Collection of asynchronous table operations      |
-| `./data_filter_snippets` | Collection of operations using [Filters](https://cloud.google.com/bigtable/docs/filters)|
+| `./data_filter_snippets` | Collection of operations using [Filters][cbt-doc-filters] |
 
 The above samples demonstrate individual data operations. Running the targets with
 the `--help` flag will display the available commands and their usage. Here is an example of one
@@ -124,7 +126,9 @@ $ ./read_snippets read-row <project-id> <instance-id> <table-id> <row-key>
 
 ## Credentials
 
-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).
+The following samples demonstrate use of [Authentication][cbt-doc-authentication]
+and [Access Control][cbt-doc-access-control] for Bigtable. More details on the samples
+can be found [here][doxygen-grpc].
 
 | Target                              | Description                            |
 | ----------------------------------- | -------------------------------------- |
@@ -137,7 +141,17 @@ The following samples demonstrate use of [Authentication](https://cloud.google.c
 $ ./table_admin_iam_policy_snippets get-iam-policy <project-id> <instance-id> <table-id>
 ```
 
-[hello_world_code]: bigtable_hello_world.cc
-[instance_admin_code]: bigtable_hello_instance_admin.cc
-[table_admin_code]: bigtable_hello_table_admin.cc
+[hello-world-code]: bigtable_hello_world.cc
+[instance-admin-code]: bigtable_hello_instance_admin.cc
+[table-admin-code]: bigtable_hello_table_admin.cc
 [grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
+[cbt-doc-quickstart]: https://cloud.google.com/bigtable/docs/quickstart-cbt
+[cbt-doc-app-profiles]: https://cloud.google.com/bigtable/docs/app-profiles
+[cbt-doc-backups]: https://cloud.google.com/bigtable/docs/backups
+[cbt-doc-filters]: https://cloud.google.com/bigtable/docs/filters
+[cbt-doc-authentication]: https://cloud.google.com/bigtable/docs/authentication
+[cbt-doc-access-control]: https://cloud.google.com/bigtable/docs/access-control
+[doxygen-hello-world]: https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-hello-world.html
+[doxygen-instance-admin]: https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-hello-instance-admin.html
+[doxygen-table-admin]: https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-hello-table-admin.html
+[doxygen-grpc]: https://googleapis.dev/cpp/google-cloud-bigtable/latest/bigtable-samples-grpc-credentials.html
