From ebca814c74196cf503d6ddf7cc5cb23ebac9360b Mon Sep 17 00:00:00 2001 From: John Blum Date: Thu, 21 Jun 2018 11:43:35 -0700 Subject: [PATCH] Introduce variables for URLs and other things. Edit content. --- .../src/docs/asciidoc/index.adoc | 58 ++++++++++--------- 1 file changed, 32 insertions(+), 26 deletions(-) diff --git a/spring-geode-docs/src/docs/asciidoc/index.adoc b/spring-geode-docs/src/docs/asciidoc/index.adoc index 1ba140b1..400203cb 100644 --- a/spring-geode-docs/src/docs/asciidoc/index.adoc +++ b/spring-geode-docs/src/docs/asciidoc/index.adoc @@ -6,6 +6,17 @@ John Blum :source-highlighter: prettify :numbered: :icons: font +:hide-uri-scheme: +:apache-geode-version: 16 +:apache-geode-docs: http://geode.apache.org/docs/guide/{apache-geode-version} +:spring-boot-docs: https://docs.spring.io/spring-boot/docs/current/reference +:spring-boot-docs-html: {spring-boot-docs}/htmlsingle/ +:spring-data-commons-docs: https://docs.spring.io/spring-data/commons/docs/current/reference +:spring-data-commons-docs-html: {spring-data-commons-docs}/html +:spring-data-geode-docs: https://docs.spring.io/spring-data/geode/docs/current/reference +:spring-data-geode-docs-html: {spring-data-geode-docs}/html +:spring-framework-docs: https://docs.spring.io/spring/docs/current/spring-framework-reference +:wikipedia-docs: https://en.wikipedia.org/wiki [[abstract]] Welcome to _Spring Boot for Apache Geode & Pivotal GemFire_. @@ -19,10 +30,10 @@ when building and running Spring-powered, Apache Geode/Pivotal GemFire applicati applications are running locally, or in a managed environment, such as https://pivotal.io/platform[Pivotal CloudFoundry] (PCF). This project is a continuation and logical extension of the work that began in Spring Data for Apache Geode & Pivotal GemFire -with the relatively new https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config[Annotation-based Configuration Model] +with the relatively new {spring-data-geode-docs-html}/#bootstrap-annotation-config[Annotation-based Configuration Model] and the goals set forth with that: _enable application developers to *get up and running* as *quickly* and as *easily* as possible_. In fact, Spring Boot for Apache Geode/Pivotal GemFire builds on the very -https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config[foundation] +{spring-data-geode-docs-html}/#bootstrap-annotation-config[foundation] built into Spring Data for Apache Geode/Pivotal GemFire (SDG) as of the Spring Data *Kay* _Release Train_. [[introduction]] @@ -32,34 +43,30 @@ Spring Boot for Apache Geode & Pivotal GemFire automatically applies auto-config application concerns, or _Use Cases_, including, but not limited to: * _Look-Aside Caching_, using either Apache Geode or Pivotal GemFire as the caching provider in -https://docs.spring.io/spring/docs/current/spring-framework-reference/integration.html#cache[Spring's Cache Abstraction]. -* Using Apache Geode or Pivotal GemFire as a https://en.wikipedia.org/wiki/System_of_record[_System of Record_ (SOR)] -to persistent application state consistently and reliably with -https://docs.spring.io/spring-data/commons/docs/current/reference/html/#repositories[Spring Data Repositories]. +{spring-framework-docs}/integration.html#cache[Spring's Cache Abstraction]. +* Using Apache Geode or Pivotal GemFire as a {wikipedia-docs}/System_of_record[_System of Record_ (SOR)] to persist +application state consistently and reliably with {spring-data-commons-docs-html}/#repositories[Spring Data Repositories]. * Running _distributed computations_ with Apache Geode/Pivotal GemFire's -http://geode.apache.org/docs/guide/16/developing/function_exec/chapter_overview.html[Function Execution API], +{apache-geode-docs}/developing/function_exec/chapter_overview.html[Function Execution API], conveniently invoked with Spring Data for Apache Geode/Pivotal GemFire -https://docs.spring.io/spring-data/geode/docs/current/reference/html/#function-annotations[POJO-based, Annotation Support for Function Executions & Implementations]. +{spring-data-geode-docs-html}/#function-annotations[POJO-based, Annotation Support for Function Executions & Implementations]. * Registering interests in and reacting to a stream of events with Apache Geode/Pivotal GemFire -http://geode.apache.org/docs/guide/16/developing/continuous_querying/chapter_overview.html[Continuous Query (CQ)] +{apache-geode-docs}/developing/continuous_querying/chapter_overview.html[Continuous Query (CQ)] where process handlers can be defined as simple Message-Driven POJOs (MDP) using Spring's -https://docs.spring.io/spring/docs/current/spring-framework-reference/integration.html#jms-mdp[Message Listener Container], -which is https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config-continuous-queries[configurable] -and https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis:continuous-query[implemented] +{spring-framework-docs}/integration.html#jms-mdp[Message Listener Container], +which is {spring-data-geode-docs-html}/#bootstrap-annotation-config-continuous-queries[configurable] +and {spring-data-geode-docs-html}/#apis:continuous-query[implemented] in Spring Data for Apache Geode/Pivotal GemFire CQ. -* Data Serialization with Apache Geode/Pivotal GemFire -http://geode.apache.org/docs/guide/16/developing/data_serialization/gemfire_pdx_serialization.html[PDX] +* Data Serialization with Apache Geode/Pivotal GemFire {apache-geode-docs}/developing/data_serialization/gemfire_pdx_serialization.html[PDX] for which Spring Data for Apache Geode/Pivotal GemFire provides first-class -https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config-pdx[configuration] -and https://docs.spring.io/spring-data/geode/docs/current/reference/html/#mapping.pdx-serializer[support]. +{spring-data-geode-docs-html}/#bootstrap-annotation-config-pdx[configuration] +and {spring-data-geode-docs-html}/#mapping.pdx-serializer[support]. * Security, encompassing all aspects of the term, including -http://geode.apache.org/docs/guide/16/managing/security/authentication_overview.html[Authentication] / -http://geode.apache.org/docs/guide/16/managing/security/authorization_overview.html[Authorization] +{apache-geode-docs}/managing/security/authentication_overview.html[Authentication]/{apache-geode-docs}/managing/security/authorization_overview.html[Authorization] as well as Transport Layer Security (TLS) using Apache Geode/Pivotal GemFire's -http://geode.apache.org/docs/guide/16/managing/security/ssl_overview.html[Secure Socket Layer (SSL)]. And, once again, -Spring Data for Apache Gedoe/Pivotal GemFire has you covered with both -https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config-security[Auth] -and https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config-ssl[SSL]. +{apache-geode-docs}/managing/security/ssl_overview.html[Secure Socket Layer (SSL)]. +And, once again, Spring Data for Apache Geode/Pivotal GemFire has you covered with both +{spring-data-geode-docs-html}/#bootstrap-annotation-config-security[Auth] and {spring-data-geode-docs-html}/#bootstrap-annotation-config-ssl[SSL]. While Spring Data for Apache Geode & Pivotal GemFire offers a simple, convenient and declarative approach for configuring all these really powerful Apache Geode/Pivotal GemFire features, Spring Boot for Apache Geode @@ -72,12 +79,12 @@ In order to be effective with and productive using Spring Boot for Apache Geode/ to understand the foundation on which this project was built. Of course, our story begins with the core Spring Framework itself, and specifically, the foundation laid down -by the Spring container's https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#spring-core[core technologies and concepts]. +by the Spring container's {spring-framework-docs}/core.html#spring-core[core technologies and concepts]. Then, our journey continues with the extensions built into Spring Data for Apache Geode & Pivotal GemFire (SDG) to truly simplify the development of GemFire/Geode applications in a Spring context, using Spring's powerful and highly consistent programming model. This part of the story was greatly enhanced in Spring Data Kay, with SDG's new -https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config[configuration model using annotations]. +{spring-data-geode-docs-html}/#bootstrap-annotation-config[configuration model using annotations]. Though this new annotation-based configuration approach provides sensible defaults out-of-the-box, its use is very explicit and it assumes nothing. That is, you still must tell SDG what you want. @@ -86,8 +93,7 @@ approach for getting the most out of your Spring GemFire/Geode-based application We do that by combining Spring Data for Apache Geode/Pivotal GemFire's Annotation-based Configuration with Spring Boot using "_auto-configuration_" to get you going even faster and more reliably so that you are productive from the start. -As such, it would be pertinent to begin your Spring Boot education -https://docs.spring.io/spring-boot/docs/2.0.0.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started[here]. +As such, it would be pertinent to begin your Spring Boot education {spring-boot-docs-html}/#getting-started[here]. Finally, we arrive at Spring Boot for Apache Geode & Pivotal GemFire.