Skip to content

Commit 05dc56b

Browse files
coryancoryan
authored
doc: declutter generated README files (#10562)
1 parent 3eaca03 commit 05dc56b

97 files changed

Lines changed: 825 additions & 3587 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎generator/internal/scaffold_generator.cc‎

Lines changed: 8 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -232,25 +232,6 @@ This directory contains an idiomatic C++ client library for the
232232
$status$ note that the Google Cloud C++ client
233233
libraries do **not** follow [Semantic Versioning](https://semver.org/).
234234
235-
## Supported Platforms
236-
237-
* Windows, macOS, Linux
238-
* C++14 (and higher) compilers (we test with GCC >= 7.3, Clang >= 6.0, and
239-
MSVC >= 2017)
240-
* Environments with or without exceptions
241-
* Bazel (>= 4.0) and CMake (>= 3.5) builds
242-
243-
## Documentation
244-
245-
* Official documentation about the [$title$][cloud-service-docs] service
246-
* [Reference doxygen documentation][doxygen-link] for each release of this
247-
client library
248-
* Detailed header comments in our [public `.h`][source-link] files
249-
250-
[cloud-service-docs]: https://cloud.google.com/$site_root$
251-
[doxygen-link]: https://googleapis.dev/cpp/google-cloud-$library$/latest/
252-
[source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/$library$
253-
254235
## Quickstart
255236
256237
The [quickstart/](quickstart/README.md) directory contains a minimal environment
@@ -261,32 +242,16 @@ this library.
261242
<!-- inject-quickstart-start -->
262243
<!-- inject-quickstart-end -->
263244
264-
* Packaging maintainers or developers who prefer to install the library in a
265-
fixed directory (such as `/usr/local` or `/opt`) should consult the
266-
[packaging guide](/doc/packaging.md).
267-
- Developers who prefer using a package manager such as
268-
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
269-
or [Conan](https://conan.io) should follow the instructions for their package
270-
manager.
271-
* Developers wanting to use the libraries as part of a larger CMake or Bazel
272-
project should consult the [quickstart guides](#quickstart) for the library
273-
or libraries they want to use.
274-
* Developers wanting to compile the library just to run some examples or
275-
tests should read the current document.
276-
* Contributors and developers to `google-cloud-cpp` should consult the guide to
277-
[set up a development workstation][howto-setup-dev-workstation].
278-
279-
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
280-
281-
## Contributing changes
245+
## More Information
282246
283-
See [`CONTRIBUTING.md`](/CONTRIBUTING.md) for details on how to
284-
contribute to this project, including how to build and test your changes
285-
as well as how to properly format your code.
286-
287-
## Licensing
247+
* Official documentation about the [$title$][cloud-service-docs] service
248+
* [Reference doxygen documentation][doxygen-link] for each release of this
249+
client library
250+
* Detailed header comments in our [public `.h`][source-link] files
288251
289-
Apache 2.0; see [`LICENSE`](/LICENSE) for details.
252+
[cloud-service-docs]: https://cloud.google.com/$site_root$
253+
[doxygen-link]: https://googleapis.dev/cpp/google-cloud-$library$/latest/
254+
[source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/$library$
290255
)""";
291256
google::protobuf::io::OstreamOutputStream output(&os);
292257
google::protobuf::io::Printer printer(&output, '$');

‎google/cloud/accessapproval/README.md‎

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,16 @@ data by Google personnel.
77
While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
88
[Semantic Versioning](https://semver.org/).
99

10-
## Supported Platforms
11-
12-
- Windows, macOS, Linux
13-
- C++14 (and higher) compilers (we test with GCC >= 7.3, Clang >= 6.0, and
14-
MSVC >= 2017)
15-
- Environments with or without exceptions
16-
- Bazel (>= 4.0) and CMake (>= 3.5) builds
17-
18-
## Documentation
19-
20-
- Official documentation about the [Access Approval API][cloud-service-docs] service
21-
- [Reference doxygen documentation][doxygen-link] for each release of this
22-
client library
23-
- Detailed header comments in our [public `.h`][source-link] files
24-
2510
## Quickstart
2611

2712
The [quickstart/](quickstart/README.md) directory contains a minimal environment
2813
to get started using this client library in a larger project. The following
2914
"Hello World" program is used in this quickstart, and should give you a taste of
3015
this library.
3116

17+
For detailed instructions on how to build and install this library, see the
18+
top-level [README](/README.md#building-and-installing).
19+
3220
<!-- inject-quickstart-start -->
3321

3422
```cc
@@ -60,28 +48,13 @@ int main(int argc, char* argv[]) try {
6048
6149
<!-- inject-quickstart-end -->
6250
63-
- Packaging maintainers or developers who prefer to install the library in a
64-
fixed directory (such as `/usr/local` or `/opt`) should consult the
65-
[packaging guide](/doc/packaging.md).
66-
- Developers wanting to use the libraries as part of a larger CMake or Bazel
67-
project should consult the [quickstart guides](#quickstart) for the library
68-
or libraries they want to use.
69-
- Developers wanting to compile the library just to run some examples or
70-
tests should read the current document.
71-
- Contributors and developers to `google-cloud-cpp` should consult the guide to
72-
[setup a development workstation][howto-setup-dev-workstation].
73-
74-
## Contributing changes
75-
76-
See [`CONTRIBUTING.md`](/CONTRIBUTING.md) for details on how to
77-
contribute to this project, including how to build and test your changes
78-
as well as how to properly format your code.
79-
80-
## Licensing
51+
## More Information
8152
82-
Apache 2.0; see [`LICENSE`](/LICENSE) for details.
53+
- Official documentation about the [Access Approval API][cloud-service-docs] service
54+
- [Reference doxygen documentation][doxygen-link] for each release of this
55+
client library
56+
- Detailed header comments in our [public `.h`][source-link] files
8357
8458
[cloud-service-docs]: https://cloud.google.com/access-approval
8559
[doxygen-link]: https://googleapis.dev/cpp/google-cloud-accessapproval/latest/
86-
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
8760
[source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/accessapproval

‎google/cloud/accesscontextmanager/README.md‎

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,16 @@ attribute based access control on requests to GCP services.
77
While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
88
[Semantic Versioning](https://semver.org/).
99

10-
## Supported Platforms
11-
12-
- Windows, macOS, Linux
13-
- C++14 (and higher) compilers (we test with GCC >= 7.3, Clang >= 6.0, and
14-
MSVC >= 2017)
15-
- Environments with or without exceptions
16-
- Bazel (>= 4.0) and CMake (>= 3.5) builds
17-
18-
## Documentation
19-
20-
- Official documentation about the [Access Context Manager API][cloud-service-docs] service
21-
- [Reference doxygen documentation][doxygen-link] for each release of this
22-
client library
23-
- Detailed header comments in our [public `.h`][source-link] files
24-
2510
## Quickstart
2611

2712
The [quickstart/](quickstart/README.md) directory contains a minimal environment
2813
to get started using this client library in a larger project. The following
2914
"Hello World" program is used in this quickstart, and should give you a taste of
3015
this library.
3116

17+
For detailed instructions on how to build and install this library, see the
18+
top-level [README](/README.md#building-and-installing).
19+
3220
<!-- inject-quickstart-start -->
3321

3422
```cc
@@ -60,28 +48,13 @@ int main(int argc, char* argv[]) try {
6048
6149
<!-- inject-quickstart-end -->
6250
63-
- Packaging maintainers or developers who prefer to install the library in a
64-
fixed directory (such as `/usr/local` or `/opt`) should consult the
65-
[packaging guide](/doc/packaging.md).
66-
- Developers wanting to use the libraries as part of a larger CMake or Bazel
67-
project should consult the [quickstart guides](#quickstart) for the library
68-
or libraries they want to use.
69-
- Developers wanting to compile the library just to run some examples or
70-
tests should read the current document.
71-
- Contributors and developers to `google-cloud-cpp` should consult the guide to
72-
[setup a development workstation][howto-setup-dev-workstation].
73-
74-
## Contributing changes
75-
76-
See [`CONTRIBUTING.md`](/CONTRIBUTING.md) for details on how to
77-
contribute to this project, including how to build and test your changes
78-
as well as how to properly format your code.
79-
80-
## Licensing
51+
## More Information
8152
82-
Apache 2.0; see [`LICENSE`](/LICENSE) for details.
53+
- Official documentation about the [Access Context Manager API][cloud-service-docs] service
54+
- [Reference doxygen documentation][doxygen-link] for each release of this
55+
client library
56+
- Detailed header comments in our [public `.h`][source-link] files
8357
8458
[cloud-service-docs]: https://cloud.google.com/access-context-manager
8559
[doxygen-link]: https://googleapis.dev/cpp/google-cloud-accesscontextmanager/latest/
86-
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
8760
[source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/accesscontextmanager

‎google/cloud/apigateway/README.md‎

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,16 @@ manage APIs with a fully managed gateway.
77
While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
88
[Semantic Versioning](https://semver.org/).
99

10-
## Supported Platforms
11-
12-
- Windows, macOS, Linux
13-
- C++14 (and higher) compilers (we test with GCC >= 7.3, Clang >= 6.0, and
14-
MSVC >= 2017)
15-
- Environments with or without exceptions
16-
- Bazel (>= 4.0) and CMake (>= 3.5) builds
17-
18-
## Documentation
19-
20-
- Official documentation about the [API Gateway API][cloud-service-docs] service
21-
- [Reference doxygen documentation][doxygen-link] for each release of this
22-
client library
23-
- Detailed header comments in our [public `.h`][source-link] files
24-
2510
## Quickstart
2611

2712
The [quickstart/](quickstart/README.md) directory contains a minimal environment
2813
to get started using this client library in a larger project. The following
2914
"Hello World" program is used in this quickstart, and should give you a taste of
3015
this library.
3116

17+
For detailed instructions on how to build and install this library, see the
18+
top-level [README](/README.md#building-and-installing).
19+
3220
<!-- inject-quickstart-start -->
3321

3422
```cc
@@ -61,28 +49,13 @@ int main(int argc, char* argv[]) try {
6149
6250
<!-- inject-quickstart-end -->
6351
64-
- Packaging maintainers or developers who prefer to install the library in a
65-
fixed directory (such as `/usr/local` or `/opt`) should consult the
66-
[packaging guide](/doc/packaging.md).
67-
- Developers wanting to use the libraries as part of a larger CMake or Bazel
68-
project should consult the [quickstart guides](#quickstart) for the library
69-
or libraries they want to use.
70-
- Developers wanting to compile the library just to run some examples or
71-
tests should read the current document.
72-
- Contributors and developers to `google-cloud-cpp` should consult the guide to
73-
[setup a development workstation][howto-setup-dev-workstation].
74-
75-
## Contributing changes
76-
77-
See [`CONTRIBUTING.md`](/CONTRIBUTING.md) for details on how to
78-
contribute to this project, including how to build and test your changes
79-
as well as how to properly format your code.
80-
81-
## Licensing
52+
## More Information
8253
83-
Apache 2.0; see [`LICENSE`](/LICENSE) for details.
54+
- Official documentation about the [API Gateway API][cloud-service-docs] service
55+
- [Reference doxygen documentation][doxygen-link] for each release of this
56+
client library
57+
- Detailed header comments in our [public `.h`][source-link] files
8458
8559
[cloud-service-docs]: https://cloud.google.com/api-gateway
8660
[doxygen-link]: https://googleapis.dev/cpp/google-cloud-apigateway/latest/
87-
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
8861
[source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/apigateway

‎google/cloud/apigeeconnect/README.md‎

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,16 @@ This library is **experimental**. Its APIs are subject to change without notice.
1414
While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
1515
[Semantic Versioning](https://semver.org/).
1616

17-
## Supported Platforms
18-
19-
- Windows, macOS, Linux
20-
- C++14 (and higher) compilers (we test with GCC >= 7.3, Clang >= 6.0, and
21-
MSVC >= 2017)
22-
- Environments with or without exceptions
23-
- Bazel (>= 4.0) and CMake (>= 3.5) builds
24-
25-
## Documentation
26-
27-
- Official documentation about the [Apigee Connect API][cloud-service-docs] service
28-
- [Reference doxygen documentation][doxygen-link] for each release of this
29-
client library
30-
- Detailed header comments in our [public `.h`][source-link] files
31-
3217
## Quickstart
3318

3419
The [quickstart/](quickstart/README.md) directory contains a minimal environment
3520
to get started using this client library in a larger project. The following
3621
"Hello World" program is used in this quickstart, and should give you a taste of
3722
this library.
3823

24+
For detailed instructions on how to build and install this library, see the
25+
top-level [README](/README.md#building-and-installing).
26+
3927
<!-- inject-quickstart-start -->
4028

4129
```cc
@@ -68,28 +56,13 @@ int main(int argc, char* argv[]) try {
6856
6957
<!-- inject-quickstart-end -->
7058
71-
- Packaging maintainers or developers who prefer to install the library in a
72-
fixed directory (such as `/usr/local` or `/opt`) should consult the
73-
[packaging guide](/doc/packaging.md).
74-
- Developers wanting to use the libraries as part of a larger CMake or Bazel
75-
project should consult the [quickstart guides](#quickstart) for the library
76-
or libraries they want to use.
77-
- Developers wanting to compile the library just to run some examples or
78-
tests should read the current document.
79-
- Contributors and developers to `google-cloud-cpp` should consult the guide to
80-
[setup a development workstation][howto-setup-dev-workstation].
81-
82-
## Contributing changes
83-
84-
See [`CONTRIBUTING.md`](/CONTRIBUTING.md) for details on how to
85-
contribute to this project, including how to build and test your changes
86-
as well as how to properly format your code.
87-
88-
## Licensing
59+
## More Information
8960
90-
Apache 2.0; see [`LICENSE`](/LICENSE) for details.
61+
- Official documentation about the [Apigee Connect API][cloud-service-docs] service
62+
- [Reference doxygen documentation][doxygen-link] for each release of this
63+
client library
64+
- Detailed header comments in our [public `.h`][source-link] files
9165
9266
[cloud-service-docs]: https://cloud.google.com/apigee/docs/hybrid/
9367
[doxygen-link]: https://googleapis.dev/cpp/google-cloud-apigeeconnect/latest/
94-
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
9568
[source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/apigeeconnect

0 commit comments

Comments
 (0)