From 9db5ce4c4cd2eea3803b27ce059dc036459869ac Mon Sep 17 00:00:00 2001 From: Roy Clarkson Date: Thu, 30 Jan 2020 17:14:47 -0500 Subject: [PATCH] Extract versions and urls from reference docs --- .../src/docs/asciidoc/getting-started.adoc | 14 ++++++++------ .../src/docs/asciidoc/index.adoc | 3 ++- .../src/docs/asciidoc/service-bindings.adoc | 4 ++-- .../src/docs/asciidoc/service-instances.adoc | 8 ++++---- 4 files changed, 16 insertions(+), 13 deletions(-) diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/getting-started.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/getting-started.adoc index 66fe9a5..df1e8fb 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/getting-started.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/getting-started.adoc @@ -7,25 +7,27 @@ Create a Spring Boot application and include the Spring Cloud App Broker depende Include the following in your application's `pom.xml` file: -```xml +[source,xml,subs="attributes+"] +---- org.springframework.cloud spring-cloud-starter-app-broker-cloudfoundry - 1.0.0.BUILD-SNAPSHOT + {project-version} -``` +---- === Gradle Dependencies Include the following in your application's `build.gradle` file: -```groovy +[source,groovy,subs="attributes+"] +---- dependencies { - compile 'org.springframework.cloud:spring-cloud-starter-app-broker-cloudfoundry:1.0.0.BUILD-SNAPSHOT' + api 'org.springframework.cloud:spring-cloud-starter-app-broker-cloudfoundry:{project-version}' } -``` +---- === Configuring the Service Broker diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc index e87f792..15879d6 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc @@ -8,7 +8,8 @@ :sapbr: https://cloud.spring.io/spring-cloud-app-broker/ :sapbr-href: {sapbr}[Spring Cloud App Broker] -:sapbr-api: https://docs.spring.io/spring-cloud-app-broker/docs/current/apidocs/ +:sapbr-api: https://docs.spring.io/spring-cloud-app-broker/docs/{project-version}/api/ +:sapbr-docs: https://docs.spring.io/spring-cloud-app-broker/docs/{project-version}/reference/html5/ :source: {github}/tree/{branch-or-tag} :scosb: https://cloud.spring.io/spring-cloud-open-service-broker/ :scosb-href: {scosb}[Spring Cloud Open Service Broker] diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc index 2f7b5e5..b8ddfb4 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc @@ -7,8 +7,8 @@ By default, Spring Cloud App Broker does not include functionality for managing === Creating a Service Binding -The service broker application can implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/CreateServiceInstanceAppBindingWorkflow.html[`CreateServiceInstanceAppBindingWorkflow`] interface. Alternatively, the service broker application can implement the `ServiceInstanceBindingService` interface provided by Spring Cloud Open Service Broker. See https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/#service-bindings[Service Bindings] in the https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/[Spring Cloud Open Service Broker documentation]. +The service broker application can implement the {sapbr-api}/org/springframework/cloud/appbroker/service/CreateServiceInstanceAppBindingWorkflow.html[`CreateServiceInstanceAppBindingWorkflow`] interface. Alternatively, the service broker application can implement the `ServiceInstanceBindingService` interface provided by Spring Cloud Open Service Broker. See {scosb-docs}/#service-bindings[Service Bindings] in the {scosb-docs}/[Spring Cloud Open Service Broker documentation]. === Deleting a Service Binding -The service broker application can implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/DeleteServiceInstanceBindingWorkflow.html[`DeleteServiceInstanceBindingWorkflow`] interface. Alternatively, the service broker application can implement the `ServiceInstanceBindingService` interface provided by Spring Cloud Open Service Broker. See https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/#service-bindings[Service Bindings] in the https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/[Spring Cloud Open Service Broker documentation]. +The service broker application can implement the {sapbr-api}/org/springframework/cloud/appbroker/service/DeleteServiceInstanceBindingWorkflow.html[`DeleteServiceInstanceBindingWorkflow`] interface. Alternatively, the service broker application can implement the `ServiceInstanceBindingService` interface provided by Spring Cloud Open Service Broker. See {scosb-docs}/#service-bindings[Service Bindings] in the {scosb-docs}/[Spring Cloud Open Service Broker documentation]. diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc index 7f22111..1942ddb 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc @@ -327,16 +327,16 @@ spring: === Creating a Service Instance -Spring Cloud App Broker provides the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/workflow/instance/AppDeploymentCreateServiceInstanceWorkflow.html[`AppDeploymentCreateServiceInstanceWorkflow`] workflow, which handles deploying the configured backing applications and services as illustrated in the previous sections. The service broker application can implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/CreateServiceInstanceWorkflow.html[`CreateServiceInstanceWorkflow`] interface to further modify the deployment. Multiple workflows may be annotated with `@Order` so as to process the workflows in a specific order. Alternatively, the service broker application can implement the `ServiceInstanceService` interface provided by Spring Cloud Open Service Broker. See https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/#service-instances[Service Instances] in the https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/[Spring Cloud Open Service Broker documentation]. +Spring Cloud App Broker provides the {sapbr-api}/org/springframework/cloud/appbroker/workflow/instance/AppDeploymentCreateServiceInstanceWorkflow.html[`AppDeploymentCreateServiceInstanceWorkflow`] workflow, which handles deploying the configured backing applications and services as illustrated in the previous sections. The service broker application can implement the {sapbr-api}/org/springframework/cloud/appbroker/service/CreateServiceInstanceWorkflow.html[`CreateServiceInstanceWorkflow`] interface to further modify the deployment. Multiple workflows may be annotated with `@Order` so as to process the workflows in a specific order. Alternatively, the service broker application can implement the `ServiceInstanceService` interface provided by Spring Cloud Open Service Broker. See {scosb-docs}/#service-instances[Service Instances] in the {scosb-docs}/[Spring Cloud Open Service Broker documentation]. === Updating a Service Instance -Spring Cloud App Broker provides the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/workflow/instance/AppDeploymentUpdateServiceInstanceWorkflow.html[`AppDeploymentUpdateServiceInstanceWorkflow`] workflow, which handles updating the configured backing applications and services as illustrated in the previous sections. If the list of backing services is updated, the default behavior is to create and bind the new backing service instances, and to unbind and delete the existing backing service instances that are no longer listed in the configuration. +Spring Cloud App Broker provides the {sapbr-api}/org/springframework/cloud/appbroker/workflow/instance/AppDeploymentUpdateServiceInstanceWorkflow.html[`AppDeploymentUpdateServiceInstanceWorkflow`] workflow, which handles updating the configured backing applications and services as illustrated in the previous sections. If the list of backing services is updated, the default behavior is to create and bind the new backing service instances, and to unbind and delete the existing backing service instances that are no longer listed in the configuration. -The service broker application can implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/UpdateServiceInstanceWorkflow.html[`UpdateServiceInstanceWorkflow`] interface to further modify the deployment. Multiple workflows may be annotated with `@Order` so as to process the workflows in a specific order. Alternatively, the service broker application can implement the `ServiceInstanceService` interface provided by Spring Cloud Open Service Broker. See https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/#service-instances[Service Instances] in the https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/[Spring Cloud Open Service Broker documentation]. +The service broker application can implement the {sapbr-api}/org/springframework/cloud/appbroker/service/UpdateServiceInstanceWorkflow.html[`UpdateServiceInstanceWorkflow`] interface to further modify the deployment. Multiple workflows may be annotated with `@Order` so as to process the workflows in a specific order. Alternatively, the service broker application can implement the `ServiceInstanceService` interface provided by Spring Cloud Open Service Broker. See {scosb-docs}/#service-instances[Service Instances] in the {scosb-docs}/[Spring Cloud Open Service Broker documentation]. CAUTION: Modifying certain properties, such as disk and memory, when updating an application, may result in downtime. === Deleting a Service Instance -Spring Cloud App Broker provides the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/workflow/instance/AppDeploymentDeleteServiceInstanceWorkflow.html[`AppDeploymentDeleteServiceInstanceWorkflow`] workflow, which handles deleting the configured backing applications and services as illustrated in the previous sections. The service broker application can implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/DeleteServiceInstanceWorkflow.html[`DeleteServiceInstanceWorkflow`] interface to further modify the deployment. Multiple workflows may be annotated with `@Order` so as to process the workflows in a specific order. Alternatively, the service broker application can implement the `ServiceInstanceService` interface provided by Spring Cloud Open Service Broker. See https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/#service-instances[Service Instances] in the https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/[Spring Cloud Open Service Broker documentation]. +Spring Cloud App Broker provides the {sapbr-api}/org/springframework/cloud/appbroker/workflow/instance/AppDeploymentDeleteServiceInstanceWorkflow.html[`AppDeploymentDeleteServiceInstanceWorkflow`] workflow, which handles deleting the configured backing applications and services as illustrated in the previous sections. The service broker application can implement the {sapbr-api}/org/springframework/cloud/appbroker/service/DeleteServiceInstanceWorkflow.html[`DeleteServiceInstanceWorkflow`] interface to further modify the deployment. Multiple workflows may be annotated with `@Order` so as to process the workflows in a specific order. Alternatively, the service broker application can implement the `ServiceInstanceService` interface provided by Spring Cloud Open Service Broker. See {scosb-docs}/#service-instances[Service Instances] in the {scosb-docs}/[Spring Cloud Open Service Broker documentation].