Skip to content

Commit 9a561d2

Browse files
committed
docs: fix broken links in README.md for firestore and major libraries
Updates the shared README.md template to: - Fix Authentication and Troubleshooting links globally. - Add link to the Java-specific authentication guide. - Handle monorepo pathing for samples. Updates test goldens to match template changes. Updates `.repo-metadata.json` and regenerates `README.md` (or manually fixes them) for the following major/handwritten libraries to resolve broken Javadocs, Authentication, Troubleshooting, and Samples links: - java-bigtable - java-pubsub - java-bigquery - java-bigquerystorage - java-logging - java-logging-logback - java-storage - java-storage-nio - java-spanner - java-spanner-jdbc - java-firestore - java-datastore Fixes: #13530
1 parent ece3126 commit 9a561d2

26 files changed

Lines changed: 724 additions & 717 deletions

File tree

java-bigquery/.repo-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"api_shortname": "bigquery",
33
"name_pretty": "Cloud BigQuery",
44
"product_documentation": "https://cloud.google.com/bigquery",
5-
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-bigquery/latest/history",
5+
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-bigquery/latest/overview",
66
"api_description": "is a fully managed, NoOps, low cost data analytics service.\nData can be streamed into BigQuery at millions of rows per second to enable real-time analysis.\nWith BigQuery you can easily deploy Petabyte-scale Databases.",
77
"issue_tracker": "https://issuetracker.google.com/savedsearches/559654",
88
"release_level": "stable",

java-bigquery/README.md

Lines changed: 146 additions & 145 deletions
Large diffs are not rendered by default.

java-bigquerystorage/.repo-metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"name_pretty": "BigQuery Storage",
44
"product_documentation": "https://cloud.google.com/bigquery/docs/reference/storage/",
55
"api_description": "is an API for reading data stored in BigQuery. This API provides direct, high-throughput read access to existing BigQuery tables, supports parallel access with automatic liquid sharding, and allows fine-grained control over what data is returned.",
6-
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/history",
6+
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/overview",
77
"release_level": "stable",
88
"transport": "grpc",
99
"language": "java",
@@ -16,4 +16,4 @@
1616
"codeowner_team": "@googleapis/bigquery-team",
1717
"issue_tracker": "https://issuetracker.google.com/savedsearches/559654",
1818
"recommended_package": "com.google.cloud.bigquery.storage.v1"
19-
}
19+
}

java-bigquerystorage/README.md

Lines changed: 21 additions & 22 deletions
Large diffs are not rendered by default.

java-bigtable/.repo-metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"name_pretty": "Cloud Bigtable",
44
"product_documentation": "https://cloud.google.com/bigtable",
55
"api_description": "API for reading and writing the contents of Bigtables associated with a cloud project.",
6-
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-bigtable/latest/history",
6+
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-bigtable/latest/overview",
77
"release_level": "stable",
88
"transport": "grpc",
99
"language": "java",
@@ -18,4 +18,4 @@
1818
"issue_tracker": "https://issuetracker.google.com/savedsearches/559777",
1919
"extra_versioned_modules": "google-cloud-bigtable-emulator,google-cloud-bigtable-emulator-core",
2020
"recommended_package": "com.google.cloud.bigtable"
21-
}
21+
}

java-bigtable/README.md

Lines changed: 29 additions & 30 deletions
Large diffs are not rendered by default.

java-datastore/.repo-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"name_pretty": "Cloud Datastore",
44
"product_documentation": "https://cloud.google.com/datastore",
55
"api_description": "is a fully managed, schemaless database for\\nstoring non-relational data. Cloud Datastore automatically scales with\\nyour users and supports ACID transactions, high availability of reads and\\nwrites, strong consistency for reads and ancestor queries, and eventual\\nconsistency for all other queries.",
6-
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-datastore/latest/history",
6+
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-datastore/latest/overview",
77
"release_level": "stable",
88
"transport": "both",
99
"language": "java",

java-datastore/README.md

Lines changed: 34 additions & 35 deletions
Large diffs are not rendered by default.

java-firestore/.repo-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"name_pretty": "Cloud Firestore",
44
"product_documentation": "https://cloud.google.com/firestore",
55
"api_description": "is a fully-managed NoSQL document database for mobile, web, and server development from Firebase and Google Cloud Platform. It's backed by a multi-region replicated database that ensures once data is committed, it's durable even in the face of unexpected disasters. Not only that, but despite being a distributed database, it's also strongly consistent and offers seamless integration with other Firebase and Google Cloud Platform products, including Google Cloud Functions.",
6-
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-firestore/latest/history",
6+
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-firestore/latest/overview",
77
"release_level": "stable",
88
"transport": "grpc",
99
"language": "java",

java-firestore/README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ libraryDependencies += "com.google.cloud" % "google-cloud-firestore" % "3.43.1"
6767

6868
## Authentication
6969

70-
See the [Authentication][authentication] section in the base directory's README.
70+
See the [Authentication][authentication] guide and the [Java-specific Authentication Guide][java-authentication] for more information.
7171

7272
## Authorization
7373

@@ -102,22 +102,20 @@ use this Cloud Firestore Client Library.
102102

103103
## Samples
104104

105-
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-java/tree/main/samples) directory.
106-
105+
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-java/tree/main/java-firestore/samples) directory.
107106
| Sample | Source Code | Try it |
108107
| --------------------------- | --------------------------------- | ------ |
109-
| Pipeline Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/preview-snippets/src/main/java/com/example/firestore/PipelineSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/preview-snippets/src/main/java/com/example/firestore/PipelineSnippets.java) |
110-
| Quickstart | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/Quickstart.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/Quickstart.java) |
111-
| Example Firestore Beam Read | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamRead.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamRead.java) |
112-
| Example Firestore Beam Write | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamWrite.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamWrite.java) |
113-
| Listen Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/ListenDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/snippets/ListenDataSnippets.java) |
114-
| Manage Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/ManageDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/snippets/ManageDataSnippets.java) |
115-
| Multiple Range Inequality Filters Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/MultipleRangeInequalityFiltersSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/snippets/MultipleRangeInequalityFiltersSnippets.java) |
116-
| Query Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/QueryDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/snippets/QueryDataSnippets.java) |
117-
| References | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/References.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/snippets/References.java) |
118-
| Retrieve Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/RetrieveDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/snippets/RetrieveDataSnippets.java) |
119-
| City | [source code](https://github.com/googleapis/google-cloud-java/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/model/City.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/firestore/snippets/model/City.java) |
120-
108+
| Pipeline Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/preview-snippets/src/main/java/com/example/firestore/PipelineSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/preview-snippets/src/main/java/com/example/firestore/PipelineSnippets.java) |
109+
| Quickstart | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/Quickstart.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/Quickstart.java) |
110+
| Example Firestore Beam Read | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamRead.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamRead.java) |
111+
| Example Firestore Beam Write | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamWrite.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/beam/ExampleFirestoreBeamWrite.java) |
112+
| Listen Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/ListenDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/ListenDataSnippets.java) |
113+
| Manage Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/ManageDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/ManageDataSnippets.java) |
114+
| Multiple Range Inequality Filters Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/MultipleRangeInequalityFiltersSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/MultipleRangeInequalityFiltersSnippets.java) |
115+
| Query Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/QueryDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/QueryDataSnippets.java) |
116+
| References | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/References.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/References.java) |
117+
| Retrieve Data Snippets | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/RetrieveDataSnippets.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/RetrieveDataSnippets.java) |
118+
| City | [source code](https://github.com/googleapis/google-cloud-java/blob/main/java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/model/City.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-java&page=editor&open_in_editor=java-firestore/samples/snippets/src/main/java/com/example/firestore/snippets/model/City.java) |
121119

122120

123121
## Troubleshooting
@@ -198,18 +196,19 @@ Apache 2.0 - See [LICENSE][license] for more information.
198196
Java is a registered trademark of Oracle and/or its affiliates.
199197

200198
[product-docs]: https://cloud.google.com/firestore
201-
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-firestore/latest/history
199+
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-firestore/latest/overview
202200
[stability-image]: https://img.shields.io/badge/stability-stable-green
203201
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-firestore.svg
204202
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-firestore/3.43.1
205-
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
203+
[authentication]: https://cloud.google.com/docs/authentication/
204+
[java-authentication]: https://cloud.google.com/java/getting-started/getting-started-with-google-auth-library
206205
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
207206
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
208207
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
209208
[developer-console]: https://console.developers.google.com/
210209
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
211210
[cloud-cli]: https://cloud.google.com/cli
212-
[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md
211+
[troubleshooting]: https://cloud.google.com/java/docs/troubleshooting
213212
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md
214213
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
215214
[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE

0 commit comments

Comments
 (0)