Skip to content

Commit 164d8ab

Browse files
authored
doc(compute): update CHANGELOG and other docs for GA (googleapis#12756)
1 parent 311895c commit 164d8ab

3 files changed

Lines changed: 20 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ info, see [#7463] and [#5976].
115115
We are happy to announce the following GA libraries. Unless specifically noted,
116116
the APIs in these libraries are stable, and are ready for production use.
117117

118+
- [Compute Engine](/google/cloud/compute/README.md)
118119
- [Infrastructure Manager](/google/cloud/config/README.md)
119120
- [NetApp](/google/cloud/netapp/README.md)
120121

google/cloud/compute/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ This directory contains an idiomatic C++ client library for the
44
[Compute Engine API][cloud-service-docs], a service that lets you create and run
55
virtual machines on Google’s infrastructure.
66

7+
Compute Engine's API has a large surface and is split into multiple services, in
8+
different subdirectories, each interacting with a specific Compute Engine
9+
resource. Additionally, Compute Engine is divided into multiple libraries, one
10+
per resource, to reduce binary size.
11+
12+
CMake targets follow the naming convention
13+
`google-cloud-cpp::compute_${subdir}`, such that the "disks" library is
14+
`google-cloud-cpp::compute_disks` and the "instance_group_managers" library is
15+
`google-cloud-cpp::compute_instance_group_managers`.
16+
17+
Bazel targets follow the naming convention `compute_${subdir}` such that the
18+
"disks" library is `@google_cloud_cpp//:compute_disks` and the
19+
"instance_group_managers" library is
20+
`@google_cloud_cpp//:compute_instance_group_managers`.
21+
722
## Quickstart
823

924
The [quickstart/](quickstart/README.md) directory contains a minimal environment

google/cloud/compute/doc/main.dox

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
@mainpage Compute Engine API C++ Client Library
44

5-
An idiomatic C++ client library for the [Compute Engine API][cloud-service-docs], a service to create
6-
and manage cloud computing resources.
5+
An idiomatic C++ client library for the [Compute Engine API][cloud-service-docs],
6+
a service to create and manage cloud computing resources.
77

8-
This library requires a C++14 compiler. It is supported (and tested) on multiple
9-
Linux distributions, as well as Windows and macOS. The [README][github-readme]
10-
on [GitHub][github-link] provides detailed instructions to install the necessary
11-
dependencies, as well as how to compile the client library.
8+
While this library is **GA**, please note that the Google Cloud C++ client
9+
libraries do **not** follow [Semantic Versioning](https://semver.org/).
1210

1311
@tableofcontents{HTML:2}
1412

@@ -139,6 +137,4 @@ application.
139137
- @ref compute-env - describes environment variables that can configure the behavior of the library.
140138

141139
[cloud-service-docs]: https://cloud.google.com/compute
142-
[exponential backoff]: https://en.wikipedia.org/wiki/Exponential_backoff
143-
144140
*/

0 commit comments

Comments
 (0)