Skip to content

Commit f7149af

Browse files
dbolducdbolduc
authored
cleanup(docs): fix some scaffolding (#7834)
1 parent 49b5cc2 commit f7149af

31 files changed

Lines changed: 98 additions & 109 deletions

File tree

‎generator/internal/scaffold_generator.cc‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -577,9 +577,9 @@ An idiomatic C++ client library for
577577
[$title$](https://cloud.google.com/$site_root$/), a service that
578578
$description$
579579
580-
This library is **experimental**. Its APIS are subject to change without notice.
580+
This library is **experimental**. Its APIs are subject to change without notice.
581581
582-
This library requires a C++11 compiler, it is supported (and tested) on multiple
582+
This library requires a C++11 compiler. It is supported (and tested) on multiple
583583
Linux distributions, as well as Windows and macOS. The
584584
[README][github-readme] on [GitHub][github-link] provides detailed
585585
instructions to install the necessary dependencies, as well as how to compile
@@ -592,7 +592,7 @@ you'll need to configure your build system to discover and compile the Cloud
592592
C++ client libraries. In some cases your build system or package manager may
593593
need to download the libraries too. The Cloud C++ client libraries natively
594594
support [Bazel](https://bazel.build/) and [CMake](https://cmake.org/) as build
595-
systems. We've created a minimal, "Hello World", [quickstart][quickstart-link]
595+
systems. We've created a minimal, "Hello World", [quickstart][github-quickstart]
596596
that includes detailed instructions on how to compile the library for use in
597597
your application. You can fetch the source from [GitHub][github-link] as normal:
598598
@@ -666,6 +666,7 @@ can override the default policies.
666666
<!-- The ugly %2E disables auto-linking in Doxygen -->
667667
[github-readme]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/$library$/README%2Emd
668668
[github-install]: https://github.com/googleapis/google-cloud-cpp/blob/main/doc/packaging%2Emd
669+
[github-quickstart]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/$library$/quickstart/README%2Emd
669670
670671
*/
671672
)""";
@@ -702,14 +703,12 @@ some experience as a C++ developer and that you have a working C++ toolchain
702703
## Before you begin
703704
704705
To run the quickstart examples you will need a working Google Cloud Platform
705-
(GCP) project, as well as a Cloud Spanner instance and database.
706-
The [quickstart][quickstart-link] covers the necessary
707-
steps in detail. Make a note of the GCP project id, the instance id, and the
708-
database id as you will need them below.
706+
(GCP) project. The [quickstart][quickstart-link] covers the necessary
707+
steps in detail.
709708
710709
## Configuring authentication for the C++ Client Library
711710
712-
Like most Google Cloud Platform (GCP) services, Cloud Spanner requires that
711+
Like most Google Cloud Platform (GCP) services, $title$ requires that
713712
your application authenticates with the service before accessing any data. If
714713
you are not familiar with GCP authentication please take this opportunity to
715714
review the [Authentication Overview][authentication-quickstart]. This library
@@ -838,7 +837,7 @@ set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
838837
```
839838
840839
[bazel-install]: https://docs.bazel.build/versions/main/install.html
841-
[quickstart-link]: https://cloud.google.com/$site_root$/docs
840+
[quickstart-link]: https://cloud.google.com/$site_root$/docs/quickstart
842841
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
843842
[choco-cmake-link]: https://chocolatey.org/packages/cmake
844843
[homebrew-cmake-link]: https://formulae.brew.sh/formula/cmake

‎google/cloud/accessapproval/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains an idiomatic C++ client library for the
66
[Access Approval API][cloud-service-docs], a service for controlling access to
77
data by Google personnel.
88

9-
This library is **experimental**. Its APIS are subject to change without notice.
9+
This library is **experimental**. Its APIs are subject to change without notice.
1010

1111
Please note that the Google Cloud C++ client libraries do **not** follow
1212
[Semantic Versioning](https://semver.org/).

‎google/cloud/accessapproval/doc/main.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ An idiomatic C++ client library for the
66
[Access Approval API](https://cloud.google.com/access-approval/),
77
a service for controlling access to data by Google personnel.
88

9-
This library is **experimental**. Its APIS are subject to change without notice.
9+
This library is **experimental**. Its APIs are subject to change without notice.
1010

11-
This library requires a C++11 compiler, it is supported (and tested) on multiple
11+
This library requires a C++11 compiler. It is supported (and tested) on multiple
1212
Linux distributions, as well as Windows and macOS. The
1313
[README][github-readme] on [GitHub][github-link] provides detailed
1414
instructions to install the necessary dependencies, as well as how to compile
@@ -21,7 +21,7 @@ you'll need to configure your build system to discover and compile the Cloud
2121
C++ client libraries. In some cases your build system or package manager may
2222
need to download the libraries too. The Cloud C++ client libraries natively
2323
support [Bazel](https://bazel.build/) and [CMake](https://cmake.org/) as build
24-
systems. We've created a minimal, "Hello World", [quickstart][quickstart-link]
24+
systems. We've created a minimal, "Hello World", [quickstart][github-quickstart]
2525
that includes detailed instructions on how to compile the library for use in
2626
your application. You can fetch the source from [GitHub][github-link] as normal:
2727

@@ -95,5 +95,6 @@ can override the default policies.
9595
<!-- The ugly %2E disables auto-linking in Doxygen -->
9696
[github-readme]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/accessapproval/README%2Emd
9797
[github-install]: https://github.com/googleapis/google-cloud-cpp/blob/main/doc/packaging%2Emd
98+
[github-quickstart]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/accessapproval/quickstart/README%2Emd
9899

99100
*/

‎google/cloud/accessapproval/quickstart/README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,12 @@ some experience as a C++ developer and that you have a working C++ toolchain
2323
## Before you begin
2424

2525
To run the quickstart examples you will need a working Google Cloud Platform
26-
(GCP) project, as well as a Cloud Spanner instance and database.
27-
The [quickstart][quickstart-link] covers the necessary
28-
steps in detail. Make a note of the GCP project id, the instance id, and the
29-
database id as you will need them below.
26+
(GCP) project. The [quickstart][quickstart-link] covers the necessary
27+
steps in detail.
3028

3129
## Configuring authentication for the C++ Client Library
3230

33-
Like most Google Cloud Platform (GCP) services, Cloud Spanner requires that
31+
Like most Google Cloud Platform (GCP) services, Access Approval requires that
3432
your application authenticates with the service before accessing any data. If
3533
you are not familiar with GCP authentication please take this opportunity to
3634
review the [Authentication Overview][authentication-quickstart]. This library
@@ -159,7 +157,7 @@ set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
159157
```
160158

161159
[bazel-install]: https://docs.bazel.build/versions/main/install.html
162-
[quickstart-link]: https://cloud.google.com/access-approval/docs
160+
[quickstart-link]: https://cloud.google.com/access-approval/docs/quickstart
163161
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
164162
[choco-cmake-link]: https://chocolatey.org/packages/cmake
165163
[homebrew-cmake-link]: https://formulae.brew.sh/formula/cmake

‎google/cloud/assuredworkloads/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains an idiomatic C++ client library for
66
[Assured Workloads API][cloud-service-docs], a service to accelerate your path
77
to running more secure and compliant workloads on Google Cloud.
88

9-
This library is **experimental**. Its APIS are subject to change without notice.
9+
This library is **experimental**. Its APIs are subject to change without notice.
1010

1111
Please note that the Google Cloud C++ client libraries do **not** follow
1212
[Semantic Versioning](https://semver.org/).

‎google/cloud/assuredworkloads/doc/main.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ An idiomatic C++ client library for
77
to accelerate your path to running more secure and compliant workloads on Google
88
Cloud.
99

10-
This library is **experimental**. Its APIS are subject to change without notice.
10+
This library is **experimental**. Its APIs are subject to change without notice.
1111

12-
This library requires a C++11 compiler, it is supported (and tested) on multiple
12+
This library requires a C++11 compiler. It is supported (and tested) on multiple
1313
Linux distributions, as well as Windows and macOS. The
1414
[README][github-readme] on [GitHub][github-link] provides detailed
1515
instructions to install the necessary dependencies, as well as how to compile
@@ -22,7 +22,7 @@ you'll need to configure your build system to discover and compile the Cloud
2222
C++ client libraries. In some cases your build system or package manager may
2323
need to download the libraries too. The Cloud C++ client libraries natively
2424
support [Bazel](https://bazel.build/) and [CMake](https://cmake.org/) as build
25-
systems. We've created a minimal, "Hello World", [quickstart][quickstart-link]
25+
systems. We've created a minimal, "Hello World", [quickstart][github-quickstart]
2626
that includes detailed instructions on how to compile the library for use in
2727
your application. You can fetch the source from [GitHub][github-link] as normal:
2828

@@ -96,5 +96,6 @@ can override the default policies.
9696
<!-- The ugly %2E disables auto-linking in Doxygen -->
9797
[github-readme]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/assuredworkloads/README%2Emd
9898
[github-install]: https://github.com/googleapis/google-cloud-cpp/blob/main/doc/packaging%2Emd
99+
[github-quickstart]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/assuredworkloads/quickstart/README%2Emd
99100

100101
*/

‎google/cloud/assuredworkloads/quickstart/README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,12 @@ some experience as a C++ developer and that you have a working C++ toolchain
2323
## Before you begin
2424

2525
To run the quickstart examples you will need a working Google Cloud Platform
26-
(GCP) project, as well as a Cloud Spanner instance and database.
27-
The [quickstart][quickstart-link] covers the necessary
28-
steps in detail. Make a note of the GCP project id, the instance id, and the
29-
database id as you will need them below.
26+
(GCP) project. The [quickstart][quickstart-link] covers the necessary
27+
steps in detail.
3028

3129
## Configuring authentication for the C++ Client Library
3230

33-
Like most Google Cloud Platform (GCP) services, Cloud Spanner requires that
31+
Like most Google Cloud Platform (GCP) services, Assured Workloads requires that
3432
your application authenticates with the service before accessing any data. If
3533
you are not familiar with GCP authentication please take this opportunity to
3634
review the [Authentication Overview][authentication-quickstart]. This library
@@ -159,7 +157,7 @@ set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
159157
```
160158

161159
[bazel-install]: https://docs.bazel.build/versions/main/install.html
162-
[quickstart-link]: https://cloud.google.com/assuredworkloads/docs
160+
[quickstart-link]: https://cloud.google.com/assuredworkloads/docs/how-to-get-started
163161
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
164162
[choco-cmake-link]: https://chocolatey.org/packages/cmake
165163
[homebrew-cmake-link]: https://formulae.brew.sh/formula/cmake

‎google/cloud/kms/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This directory contains an idiomatic C++ client library for
77
keys and performs cryptographic operations in a central cloud service, for
88
direct use by other cloud resources and applications.
99

10-
This library is **experimental**. Its APIS are subject to change without notice.
10+
This library is **experimental**. Its APIs are subject to change without notice.
1111

1212
Please note that the Google Cloud C++ client libraries do **not** follow
1313
[Semantic Versioning](https://semver.org/).

‎google/cloud/kms/doc/main.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ An idiomatic C++ client library for
77
that manages keys and performs cryptographic operations in a central cloud
88
service, for direct use by other cloud resources and applications.
99

10-
This library is **experimental**. Its APIS are subject to change without notice.
10+
This library is **experimental**. Its APIs are subject to change without notice.
1111

12-
This library requires a C++11 compiler, it is supported (and tested) on multiple
12+
This library requires a C++11 compiler. It is supported (and tested) on multiple
1313
Linux distributions, as well as Windows and macOS. The
1414
[README][github-readme] on [GitHub][github-link] provides detailed
1515
instructions to install the necessary dependencies, as well as how to compile
@@ -22,7 +22,7 @@ you'll need to configure your build system to discover and compile the Cloud
2222
C++ client libraries. In some cases your build system or package manager may
2323
need to download the libraries too. The Cloud C++ client libraries natively
2424
support [Bazel](https://bazel.build/) and [CMake](https://cmake.org/) as build
25-
systems. We've created a minimal, "Hello World", [quickstart][quickstart-link]
25+
systems. We've created a minimal, "Hello World", [quickstart][github-quickstart]
2626
that includes detailed instructions on how to compile the library for use in
2727
your application. You can fetch the source from [GitHub][github-link] as normal:
2828

@@ -96,5 +96,6 @@ can override the default policies.
9696
<!-- The ugly %2E disables auto-linking in Doxygen -->
9797
[github-readme]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/kms/README%2Emd
9898
[github-install]: https://github.com/googleapis/google-cloud-cpp/blob/main/doc/packaging%2Emd
99+
[github-quickstart]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/kms/quickstart/README%2Emd
99100

100101
*/

‎google/cloud/kms/quickstart/README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,12 @@ some experience as a C++ developer and that you have a working C++ toolchain
2323
## Before you begin
2424

2525
To run the quickstart examples you will need a working Google Cloud Platform
26-
(GCP) project, as well as a Cloud Spanner instance and database.
27-
The [quickstart][quickstart-link] covers the necessary
28-
steps in detail. Make a note of the GCP project id, the instance id, and the
29-
database id as you will need them below.
26+
(GCP) project. The [quickstart][quickstart-link] covers the necessary
27+
steps in detail.
3028

3129
## Configuring authentication for the C++ Client Library
3230

33-
Like most Google Cloud Platform (GCP) services, Cloud Spanner requires that
31+
Like most Google Cloud Platform (GCP) services, Cloud KMS requires that
3432
your application authenticates with the service before accessing any data. If
3533
you are not familiar with GCP authentication please take this opportunity to
3634
review the [Authentication Overview][authentication-quickstart]. This library
@@ -159,7 +157,7 @@ set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
159157
```
160158

161159
[bazel-install]: https://docs.bazel.build/versions/main/install.html
162-
[quickstart-link]: https://cloud.google.com/kms/docs
160+
[quickstart-link]: https://cloud.google.com/kms/docs/quickstart
163161
[grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
164162
[choco-cmake-link]: https://chocolatey.org/packages/cmake
165163
[homebrew-cmake-link]: https://formulae.brew.sh/formula/cmake

0 commit comments

Comments
 (0)