Skip to content

Commit

Permalink
docs: update godoc uses of "provider" to "driver" or "service"… (#2557)
Browse files Browse the repository at this point in the history
  • Loading branch information
vangent committed Jul 16, 2019
1 parent 2e09fbc commit 6227a58
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -38,8 +38,8 @@ to make an application portable across cloud platforms.

The project works well with a code generator called
[Wire](https://github.com/google/wire/blob/master/README.md). It creates
human-readable code that only imports the cloud SDKs for providers you use. This
allows the Go CDK to grow to support any number of cloud providers, without
human-readable code that only imports the cloud SDKs for services you use. This
allows the Go CDK to grow to support any number of cloud services, without
increasing compile times or binary sizes, and avoiding any side effects from
`init()` functions.

Expand Down Expand Up @@ -101,16 +101,16 @@ documentation, bug reports, feature requests, or anything else. We encourage you
to experiment with the Go CDK and make contributions to help evolve it to meet
your needs!

The GitHub repository at [google/go-cloud][go-cloud] contains some provider
The GitHub repository at [google/go-cloud][go-cloud] contains some driver
implementations for each portable API. We intend to include
[Google Cloud Platform][gcp], [Amazon Web Services][aws], and [Azure][azure]
implementations, as well as prominent open source providers and at least one
implementations, as well as prominent open source services and at least one
implementation suitable for use in local testing. Unfortunately, we cannot
support every cloud provider directly from the project; however, we encourage
support every service directly from the project; however, we encourage
contributions in separate repositories.

If you create a repository that implements the Go CDK interfaces for other
providers, let us know! We would be happy to link to it here and give you a
services, let us know! We would be happy to link to it here and give you a
heads-up before making any breaking changes.

See [the contributing guide](./CONTRIBUTING.md) for more details.
Expand Down
17 changes: 9 additions & 8 deletions doc.go
Expand Up @@ -20,16 +20,17 @@ seamlessly deploy cloud applications on any combination of cloud providers.
It does this by providing stable, idiomatic interfaces for common uses like
storage and databases. Think `database/sql` for cloud products.
At the core of the Go CDK are common "portable types" implemented by cloud
providers. For example, objects of the blob.Bucket portable type can be created
using gcsblob.OpenBucket, s3blob.OpenBucket, or any other provider. Then, the
blob.Bucket can be used throughout your application without worrying about
the underlying implementation.
At the core of the Go CDK are common "portable types", implemented on top of
service-specific drivers for supported cloud services. For example,
objects of the blob.Bucket portable type can be created using
gcsblob.OpenBucket, s3blob.OpenBucket, or any other Go CDK driver. Then, the
blob.Bucket can be used throughout your application without worrying about the
underlying implementation.
The Go CDK works well with a code generator called Wire
(https://github.com/google/wire/blob/master/README.md). It creates
human-readable code that only imports the cloud SDKs for providers you use. This
allows the Go CDK to grow to support any number of cloud providers, without
human-readable code that only imports the cloud SDKs for drivers you use. This
allows the Go CDK to grow to support any number of cloud services, without
increasing compile times or binary sizes, and avoiding any side effects from
`init()` functions.
Expand All @@ -42,6 +43,6 @@ See https://gocloud.dev/concepts/urls/ for a discussion of URLs in the Go CDK.
As
See https://gocloud.dev/concepts/as/ for a discussion of how to write
provider-specific code with the Go CDK.
service-specific code with the Go CDK.
*/
package cloud // import "gocloud.dev"

0 comments on commit 6227a58

Please sign in to comment.