Skip to content

Commit

Permalink
docs: update READMEs to use pkg.go.dev (#3592)
Browse files Browse the repository at this point in the history
  • Loading branch information
tbpg committed Jan 21, 2021
1 parent 24c5b8f commit 85758d3
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions bigquery/README.md
@@ -1,8 +1,8 @@
## BigQuery [![GoDoc](https://godoc.org/cloud.google.com/go/bigquery?status.svg)](https://godoc.org/cloud.google.com/go/bigquery)
## BigQuery [![Go Reference](https://pkg.go.dev/badge/cloud.google.com/go/bigquery.svg)](https://pkg.go.dev/cloud.google.com/go/bigquery)

- [About BigQuery](https://cloud.google.com/bigquery/)
- [API documentation](https://cloud.google.com/bigquery/docs)
- [Go client documentation](https://godoc.org/cloud.google.com/go/bigquery)
- [Go client documentation](https://pkg.go.dev/cloud.google.com/go/bigquery)
- [Complete sample programs](https://github.com/GoogleCloudPlatform/golang-samples/tree/master/bigquery)

### Example Usage
Expand Down
4 changes: 2 additions & 2 deletions bigtable/cmd/cbt/README.md
Expand Up @@ -18,12 +18,12 @@ than the official one) invoke it with the directory prefix like this:

## Documentation

This tool gets documented on the [Go packages website](https://godoc.org/cloud.google.com/go/bigtable/cmd/cbt)
This tool gets documented on the [Go packages website](https://pkg.go.dev/cloud.google.com/go/bigtable/cmd/cbt)
as well as the [cloud site](https://cloud.google.com/bigtable/docs/cbt-reference).

### Go Package Documentation

This command will generate a file with a package description which gets used for the godoc.org. You should update this after any changes to the usage or descriptions of the commands. To
This command will generate a file with a package description which gets used for the pkg.go.dev. You should update this after any changes to the usage or descriptions of the commands. To
generate the file, run:

```
Expand Down
6 changes: 3 additions & 3 deletions datastore/README.md
@@ -1,9 +1,9 @@
## Cloud Datastore [![GoDoc](https://godoc.org/cloud.google.com/go/datastore?status.svg)](https://godoc.org/cloud.google.com/go/datastore)
## Cloud Datastore [![Go Reference](https://pkg.go.dev/badge/cloud.google.com/go/datastore.svg)](https://pkg.go.dev/cloud.google.com/go/datastore)

- [About Cloud Datastore](https://cloud.google.com/datastore/)
- [Activating the API for your project](https://cloud.google.com/datastore/docs/activate)
- [API documentation](https://cloud.google.com/datastore/docs)
- [Go client documentation](https://godoc.org/cloud.google.com/go/datastore)
- [Go client documentation](https://pkg.go.dev/cloud.google.com/go/datastore)
- [Complete sample program](https://github.com/GoogleCloudPlatform/golang-samples/tree/master/datastore/tasks)

### Example Usage
Expand Down Expand Up @@ -38,4 +38,4 @@ posts := []*Post{
if _, err := client.PutMulti(ctx, keys, posts); err != nil {
log.Fatal(err)
}
```
```
2 changes: 1 addition & 1 deletion logging/README.md
@@ -1,4 +1,4 @@
## Cloud Logging [![GoDoc](https://godoc.org/cloud.google.com/go/logging?status.svg)](https://godoc.org/cloud.google.com/go/logging)
## Cloud Logging [![Go Reference](https://pkg.go.dev/badge/cloud.google.com/go/logging.svg)](https://pkg.go.dev/cloud.google.com/go/logging)

- [About Cloud Logging](https://cloud.google.com/logging/)
- [API documentation](https://cloud.google.com/logging/docs)
Expand Down
6 changes: 3 additions & 3 deletions pubsub/README.md
@@ -1,8 +1,8 @@
## Cloud Pub/Sub [![GoDoc](https://godoc.org/cloud.google.com/go/pubsub?status.svg)](https://godoc.org/cloud.google.com/go/pubsub)
## Cloud Pub/Sub [![Go Reference](https://pkg.go.dev/badge/cloud.google.com/go/pubsub.svg)](https://pkg.go.dev/cloud.google.com/go/pubsub)

- [About Cloud Pubsub](https://cloud.google.com/pubsub/)
- [API documentation](https://cloud.google.com/pubsub/docs)
- [Go client documentation](https://godoc.org/cloud.google.com/go/pubsub)
- [Go client documentation](https://pkg.go.dev/cloud.google.com/go/pubsub)
- [Complete sample programs](https://github.com/GoogleCloudPlatform/golang-samples/tree/master/pubsub)

### Example Usage
Expand Down Expand Up @@ -43,4 +43,4 @@ err = sub.Receive(ctx, func(ctx context.Context, m *pubsub.Message) {
if err != nil {
log.Println(err)
}
```
```
2 changes: 1 addition & 1 deletion pubsublite/README.md
@@ -1,4 +1,4 @@
## Cloud Pub/Sub Lite [![GoDoc](https://godoc.org/cloud.google.com/go/pubsublite?status.svg)](https://pkg.go.dev/cloud.google.com/go/pubsublite)
## Cloud Pub/Sub Lite [![Go Reference](https://pkg.go.dev/badge/cloud.google.com/go/pubsublite.svg)](https://pkg.go.dev/cloud.google.com/go/pubsublite)

- [About Cloud Pub/Sub Lite](https://cloud.google.com/pubsub/lite)
- [Client library documentation](https://cloud.google.com/pubsub/lite/docs/reference/libraries)
Expand Down
6 changes: 3 additions & 3 deletions spanner/README.md
@@ -1,8 +1,8 @@
## Cloud Spanner [![GoDoc](https://godoc.org/cloud.google.com/go/spanner?status.svg)](https://godoc.org/cloud.google.com/go/spanner)
## Cloud Spanner [![Go Reference](https://pkg.go.dev/badge/cloud.google.com/go/spanner.svg)](https://pkg.go.dev/cloud.google.com/go/spanner)

- [About Cloud Spanner](https://cloud.google.com/spanner/)
- [API documentation](https://cloud.google.com/spanner/docs)
- [Go client documentation](https://godoc.org/cloud.google.com/go/spanner)
- [Go client documentation](https://pkg.go.dev/cloud.google.com/go/spanner)

### Example Usage

Expand Down Expand Up @@ -31,4 +31,4 @@ row, err := client.Single().ReadRow(ctx, "Users",
if err != nil {
log.Fatal(err)
}
```
```
6 changes: 3 additions & 3 deletions storage/README.md
@@ -1,8 +1,8 @@
## Cloud Storage [![GoDoc](https://godoc.org/cloud.google.com/go/storage?status.svg)](https://godoc.org/cloud.google.com/go/storage)
## Cloud Storage [![Go Reference](https://pkg.go.dev/badge/cloud.google.com/go/storage.svg)](https://pkg.go.dev/cloud.google.com/go/storage)

- [About Cloud Storage](https://cloud.google.com/storage/)
- [API documentation](https://cloud.google.com/storage/docs)
- [Go client documentation](https://godoc.org/cloud.google.com/go/storage)
- [Go client documentation](https://pkg.go.dev/cloud.google.com/go/storage)
- [Complete sample programs](https://github.com/GoogleCloudPlatform/golang-samples/tree/master/storage)

### Example Usage
Expand All @@ -29,4 +29,4 @@ body, err := ioutil.ReadAll(rc)
if err != nil {
log.Fatal(err)
}
```
```

0 comments on commit 85758d3

Please sign in to comment.