From 8a26f8c866afdf879dc416460822fa6b94ff2809 Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Thu, 29 Jul 2021 18:09:25 -0400 Subject: [PATCH] Fix some broken links within documentation (#554) Made edits to fix some broken links within the documentation. Added explicit block id where applicable. - all links to Bill of Materials section - links in Starter Dependencies section table - link to spring-cloud-stream from spring-cloud-bus-pubsub --- docs/src/main/asciidoc/bigquery.adoc | 2 +- docs/src/main/asciidoc/config.adoc | 1 + docs/src/main/asciidoc/core.adoc | 2 +- docs/src/main/asciidoc/datastore.adoc | 3 ++- docs/src/main/asciidoc/firestore.adoc | 4 ++-- docs/src/main/asciidoc/getting-started.adoc | 23 ++++++++++--------- docs/src/main/asciidoc/kms.adoc | 2 +- docs/src/main/asciidoc/logging.adoc | 3 ++- docs/src/main/asciidoc/metrics.adoc | 2 +- docs/src/main/asciidoc/pubsub.adoc | 3 ++- docs/src/main/asciidoc/secretmanager.adoc | 2 +- docs/src/main/asciidoc/security-iap.adoc | 3 ++- docs/src/main/asciidoc/spanner.adoc | 3 ++- .../asciidoc/spring-cloud-bus-pubsub.adoc | 4 ++-- .../asciidoc/spring-integration-pubsub.adoc | 2 +- .../asciidoc/spring-integration-storage.adoc | 2 +- docs/src/main/asciidoc/spring-stream.adoc | 3 ++- docs/src/main/asciidoc/sql.adoc | 3 ++- docs/src/main/asciidoc/storage.adoc | 3 ++- docs/src/main/asciidoc/trace.adoc | 3 ++- docs/src/main/asciidoc/vision.adoc | 5 ++-- 21 files changed, 45 insertions(+), 33 deletions(-) diff --git a/docs/src/main/asciidoc/bigquery.adoc b/docs/src/main/asciidoc/bigquery.adoc index 6254ef0a4f..d36505bb00 100644 --- a/docs/src/main/asciidoc/bigquery.adoc +++ b/docs/src/main/asciidoc/bigquery.adoc @@ -7,7 +7,7 @@ Spring Cloud GCP provides: * A convenience starter which provides autoconfiguration for the https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigquery/BigQuery.html[`BigQuery`] client objects with credentials needed to interface with BigQuery. * A Spring Integration message handler for loading data into BigQuery tables in your Spring integration pipelines. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/config.adoc b/docs/src/main/asciidoc/config.adoc index 118ee5d562..a269e9f269 100644 --- a/docs/src/main/asciidoc/config.adoc +++ b/docs/src/main/asciidoc/config.adoc @@ -1,3 +1,4 @@ +[#cloud-runtime-configuration-api] == Cloud Runtime Configuration API WARNING: The Google Cloud Runtime Configuration service is in *Beta* status, and is only available in snapshot and milestone versions of the project. It's also not available in the Spring Cloud GCP BOM, unlike other modules. diff --git a/docs/src/main/asciidoc/core.adoc b/docs/src/main/asciidoc/core.adoc index 7b88dcc887..b0c9256bb7 100644 --- a/docs/src/main/asciidoc/core.adoc +++ b/docs/src/main/asciidoc/core.adoc @@ -5,7 +5,7 @@ Each Spring Cloud GCP module uses `GcpProjectIdProvider` and `CredentialsProvide Spring Cloud GCP provides a Spring Boot starter to auto-configure the core components. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/datastore.adoc b/docs/src/main/asciidoc/datastore.adoc index 80e4bbf7aa..7b611ae999 100644 --- a/docs/src/main/asciidoc/datastore.adoc +++ b/docs/src/main/asciidoc/datastore.adoc @@ -1,5 +1,6 @@ :spring-data-commons-ref: https://docs.spring.io/spring-data/data-commons/docs/current/reference/html +[#spring-data-cloud-datastore] == Spring Data Cloud Datastore NOTE: This integration is fully compatible with https://cloud.google.com/datastore/docs/[Firestore in Datastore Mode], but not with Firestore in Native Mode. @@ -7,7 +8,7 @@ NOTE: This integration is fully compatible with https://cloud.google.com/datasto https://projects.spring.io/spring-data/[Spring Data] is an abstraction for storing and retrieving POJOs in numerous storage technologies. Spring Cloud GCP adds Spring Data support for https://cloud.google.com/firestore/[Google Cloud Firestore] in Datastore mode. -Maven coordinates for this module only, using <>: +Maven coordinates for this module only, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/firestore.adoc b/docs/src/main/asciidoc/firestore.adoc index 146d88377e..84c6cb2c80 100644 --- a/docs/src/main/asciidoc/firestore.adoc +++ b/docs/src/main/asciidoc/firestore.adoc @@ -7,7 +7,7 @@ https://projects.spring.io/spring-data/[Spring Data] is an abstraction for stori Spring Cloud GCP adds Spring Data Reactive Repositories support for https://cloud.google.com/firestore/[Google Cloud Firestore] in native mode, providing reactive template and repositories support. To begin using this library, add the `spring-cloud-gcp-data-firestore` artifact to your project. -Maven coordinates for this module only, using <>: +Maven coordinates for this module only, using <>: [source,xml] @@ -354,7 +354,7 @@ See https://cloud.google.com/firestore/docs/[documentation] to learn more about To begin using this library, add the `spring-cloud-gcp-starter-firestore` artifact to your project. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/getting-started.adoc b/docs/src/main/asciidoc/getting-started.adoc index 6ae9fd875e..7acf617d89 100644 --- a/docs/src/main/asciidoc/getting-started.adoc +++ b/docs/src/main/asciidoc/getting-started.adoc @@ -12,6 +12,7 @@ The following resources are provided to help you setup the libraries for your pr You may also consult our https://github.com/GoogleCloudPlatform/spring-cloud-gcp[Github project] to examine the code or build directly from source. +[#bill-of-materials] ==== Bill of Materials The Spring Cloud GCP Bill of Materials (BOM) contains the versions of all the dependencies it uses. @@ -66,47 +67,47 @@ A summary of these artifacts are provided below. | Cloud Spanner | Provides integrations with Google Cloud Spanner -| <> +| <> | Cloud Datastore | Provides integrations with Google Cloud Datastore -| <> +| <> | Cloud Pub/Sub | Provides integrations with Google Cloud Pub/Sub -| <> +| <> | Logging | Enables Cloud Logging -| <> +| <> | SQL - MySQL | Cloud SQL integrations with MySQL -| <> +| <> | SQL - PostgreSQL | Cloud SQL integrations with PostgreSQL -| <> +| <> | Storage | Provides integrations with Google Cloud Storage and Spring Resource -| <> +| <> | Config | Enables usage of Google Runtime Configuration API as a Spring Cloud Config server -| <> +| <> | Trace | Enables instrumentation with Google Cloud Trace -| <> +| <> | Vision | Provides integrations with Google Cloud Vision -| <> +| <> | Security - IAP | Provides a security layer over applications deployed to Google Cloud -| <> +| <> |=== diff --git a/docs/src/main/asciidoc/kms.adoc b/docs/src/main/asciidoc/kms.adoc index 91bf88f57b..2a9b58d489 100644 --- a/docs/src/main/asciidoc/kms.adoc +++ b/docs/src/main/asciidoc/kms.adoc @@ -8,7 +8,7 @@ Spring Cloud GCP offers a utility template class `KmsTemplate` which allows you To begin using this library, add the `spring-cloud-gcp-starter-kms` artifact to your project. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/logging.adoc b/docs/src/main/asciidoc/logging.adoc index ac76cfcb05..eacc1d1a15 100644 --- a/docs/src/main/asciidoc/logging.adoc +++ b/docs/src/main/asciidoc/logging.adoc @@ -1,6 +1,7 @@ +[#cloud-logging] == Cloud Logging -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/metrics.adoc b/docs/src/main/asciidoc/metrics.adoc index 8f1a1c2e43..e16077a636 100644 --- a/docs/src/main/asciidoc/metrics.adoc +++ b/docs/src/main/asciidoc/metrics.adoc @@ -6,7 +6,7 @@ Spring Boot already provides auto-configuration for Cloud Monitoring. This module enables auto-detection of the `project-id` and `credentials`. Also, it can be customized. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/pubsub.adoc b/docs/src/main/asciidoc/pubsub.adoc index 5e79973794..17cee711d8 100644 --- a/docs/src/main/asciidoc/pubsub.adoc +++ b/docs/src/main/asciidoc/pubsub.adoc @@ -1,10 +1,11 @@ +[#cloud-pubsub] == Cloud Pub/Sub Spring Cloud GCP provides an abstraction layer to publish to and subscribe from Google Cloud Pub/Sub topics and to create, list or delete Google Cloud Pub/Sub topics and subscriptions. A Spring Boot starter is provided to auto-configure the various required Pub/Sub components. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/secretmanager.adoc b/docs/src/main/asciidoc/secretmanager.adoc index da460c3716..68609ce73c 100644 --- a/docs/src/main/asciidoc/secretmanager.adoc +++ b/docs/src/main/asciidoc/secretmanager.adoc @@ -12,7 +12,7 @@ Spring Cloud GCP provides: To begin using this library, add the `spring-cloud-gcp-starter-secretmanager` artifact to your project. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/security-iap.adoc b/docs/src/main/asciidoc/security-iap.adoc index c65fb2d7f2..9a73680565 100644 --- a/docs/src/main/asciidoc/security-iap.adoc +++ b/docs/src/main/asciidoc/security-iap.adoc @@ -1,6 +1,7 @@ :spring-security-ref: https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/ :spring-security-javadoc: https://docs.spring.io/spring-security/site/docs/current/api/org/springframework/security/ +[#cloud-iap] == Cloud IAP https://cloud.google.com/iap/[Cloud Identity-Aware Proxy (IAP)] provides a security layer over applications deployed to Google Cloud. @@ -33,7 +34,7 @@ No qualifying bean of type 'com.google.cloud.spring.security.iap.AudienceProvide NOTE: If you create a custom {spring-security-javadoc}config/annotation/web/configuration/WebSecurityConfigurerAdapter.html[`WebSecurityConfigurerAdapter`], enable extracting user identity by adding `.oauth2ResourceServer().jwt()` configuration to the {spring-security-javadoc}config/annotation/web/builders/HttpSecurity.html[`HttpSecurity`] object. If no custom {spring-security-javadoc}config/annotation/web/configuration/WebSecurityConfigurerAdapter.html[`WebSecurityConfigurerAdapter`] is present, nothing needs to be done because Spring Boot will add this customization by default. -Starter Maven coordinates, using <>: +Starter Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/spanner.adoc b/docs/src/main/asciidoc/spanner.adoc index e86f01a335..c31cc15162 100644 --- a/docs/src/main/asciidoc/spanner.adoc +++ b/docs/src/main/asciidoc/spanner.adoc @@ -1,11 +1,12 @@ :spring-data-commons-ref: https://docs.spring.io/spring-data/data-commons/docs/current/reference/html +[#spring-data-cloud-spanner] == Spring Data Cloud Spanner https://projects.spring.io/spring-data/[Spring Data] is an abstraction for storing and retrieving POJOs in numerous storage technologies. Spring Cloud GCP adds Spring Data support for https://cloud.google.com/spanner/[Google Cloud Spanner]. -Maven coordinates for this module only, using <>: +Maven coordinates for this module only, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/spring-cloud-bus-pubsub.adoc b/docs/src/main/asciidoc/spring-cloud-bus-pubsub.adoc index 7d499c0aaa..d0ca9101d2 100644 --- a/docs/src/main/asciidoc/spring-cloud-bus-pubsub.adoc +++ b/docs/src/main/asciidoc/spring-cloud-bus-pubsub.adoc @@ -4,12 +4,12 @@ ifdef::env-github,env-browser[:outfilesuffix: .adoc] Using link:https://cloud.google.com/pubsub/[Cloud Pub/Sub] as the link:https://spring.io/projects/spring-cloud-bus[Spring Cloud Bus] implementation is as simple as importing the `spring-cloud-gcp-starter-bus-pubsub` starter. -This starter brings in the <>, which is used to both publish and subscribe to the bus. +This starter brings in the <>, which is used to both publish and subscribe to the bus. If the bus topic (named `springCloudBus` by default) does not exist, the binder automatically creates it. The binder also creates anonymous subscriptions for each project using the `spring-cloud-gcp-starter-bus-pubsub` starter. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/spring-integration-pubsub.adoc b/docs/src/main/asciidoc/spring-integration-pubsub.adoc index 04f6690769..c9092ab234 100644 --- a/docs/src/main/asciidoc/spring-integration-pubsub.adoc +++ b/docs/src/main/asciidoc/spring-integration-pubsub.adoc @@ -5,7 +5,7 @@ This enables messaging between different processes, applications or micro-servic The Spring Integration Channel Adapters for Google Cloud Pub/Sub are included in the `spring-cloud-gcp-pubsub` module and can be autoconfigured by using the `spring-cloud-gcp-starter-pubsub` module in combination with a Spring Integration dependency. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/spring-integration-storage.adoc b/docs/src/main/asciidoc/spring-integration-storage.adoc index cb6a109d14..46c3fc3aed 100644 --- a/docs/src/main/asciidoc/spring-integration-storage.adoc +++ b/docs/src/main/asciidoc/spring-integration-storage.adoc @@ -8,7 +8,7 @@ The Spring Integration Channel Adapters for Google Cloud Storage are included in To use the Storage portion of Spring Integration for Spring Cloud GCP, you must also provide the `spring-integration-file` dependency, since it isn't pulled transitively. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/spring-stream.adoc b/docs/src/main/asciidoc/spring-stream.adoc index e45baed5f0..d06f21a2f7 100644 --- a/docs/src/main/asciidoc/spring-stream.adoc +++ b/docs/src/main/asciidoc/spring-stream.adoc @@ -1,10 +1,11 @@ +[#spring-cloud-stream] == Spring Cloud Stream Spring Cloud GCP provides a https://cloud.spring.io/spring-cloud-stream/[Spring Cloud Stream] binder to Google Cloud Pub/Sub. The provided binder relies on the https://github.com/GoogleCloudPlatform/spring-cloud-gcp/tree/main/spring-cloud-gcp-pubsub/src/main/java/com/google/cloud/spring/pubsub/integration[Spring Integration Channel Adapters for Google Cloud Pub/Sub]. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/sql.adoc b/docs/src/main/asciidoc/sql.adoc index 7b365671da..3a1dc148f4 100644 --- a/docs/src/main/asciidoc/sql.adoc +++ b/docs/src/main/asciidoc/sql.adoc @@ -1,3 +1,4 @@ +[#cloud-sql] == Cloud SQL Spring Cloud GCP adds integrations with @@ -6,7 +7,7 @@ https://docs.spring.io/spring/docs/current/spring-framework-reference/html/jdbc. The Cloud SQL support is provided by Spring Cloud GCP in the form of two Spring Boot starters, one for MySQL and another one for PostgreSQL. The role of the starters is to read configuration from properties and assume default settings so that user experience connecting to MySQL and PostgreSQL is as simple as possible. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/storage.adoc b/docs/src/main/asciidoc/storage.adoc index 24393ddf30..3332aef63d 100644 --- a/docs/src/main/asciidoc/storage.adoc +++ b/docs/src/main/asciidoc/storage.adoc @@ -1,9 +1,10 @@ +[#cloud-storage] == Cloud Storage https://cloud.google.com/storage/docs[Google Cloud Storage] allows storing any types of files in single or multiple regions. A Spring Boot starter is provided to auto-configure the various Storage components. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/trace.adoc b/docs/src/main/asciidoc/trace.adoc index 320088ebd2..8a22a01eea 100644 --- a/docs/src/main/asciidoc/trace.adoc +++ b/docs/src/main/asciidoc/trace.adoc @@ -1,3 +1,4 @@ +[#cloud-trace] == Cloud Trace Google Cloud Platform provides a managed distributed tracing service called https://cloud.google.com/trace/[Cloud Trace], and https://cloud.spring.io/spring-cloud-sleuth/[Spring Cloud Sleuth] can be used with it to easily instrument Spring Boot applications for observability. @@ -7,7 +8,7 @@ However, on GCP, instead of running and maintaining your own Zipkin instance and This Spring Cloud GCP starter can forward Spring Cloud Sleuth traces to Cloud Trace without an intermediary Zipkin server. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- diff --git a/docs/src/main/asciidoc/vision.adoc b/docs/src/main/asciidoc/vision.adoc index e1401d831b..05c2d7477b 100644 --- a/docs/src/main/asciidoc/vision.adoc +++ b/docs/src/main/asciidoc/vision.adoc @@ -1,3 +1,4 @@ +[#cloud-vision] == Cloud Vision The https://cloud.google.com/vision/[Google Cloud Vision API] allows users to leverage machine learning algorithms for processing images and documents including: image classification, face detection, text extraction, optical character recognition, and others. @@ -14,7 +15,7 @@ Spring Cloud GCP provides: To begin using this library, add the `spring-cloud-gcp-starter-vision` artifact to your project. -Maven coordinates, using <>: +Maven coordinates, using <>: [source,xml] ---- @@ -49,7 +50,7 @@ The following options may be configured with Spring Cloud GCP Vision libraries. If you are interested in applying optical character recognition (OCR) on documents for your project, you'll need to add both `spring-cloud-gcp-starter-vision` and `spring-cloud-gcp-starter-storage` to your dependencies. The storage starter is necessary because the Cloud Vision API will process your documents and write OCR output files all within your Google Cloud Storage buckets. -Maven coordinates using <>: +Maven coordinates using <>: [source,xml] ----