diff --git a/spring-geode-docs/src/docs/asciidoc/index.adoc b/spring-geode-docs/src/docs/asciidoc/index.adoc index 93ba54a8..57e2dfad 100644 --- a/spring-geode-docs/src/docs/asciidoc/index.adoc +++ b/spring-geode-docs/src/docs/asciidoc/index.adoc @@ -48,18 +48,18 @@ Spring Boot for Apache Geode & Pivotal GemFire provides the convenience of Sprin approach using _auto-configuration_ with the Spring Framework's powerful abstractions and highly consistent programming model to truly simplify the development of Apache Geode or Pivotal GemFire applications in a Spring context. -Secondarily, Spring Boot for Apache Geode & Pivotal GemFire aims to give developers a consistent experience whether -building and running Spring Boot, Apache Geode/Pivotal GemFire applications locally or in a managed environment, +Secondarily, Spring Boot for Apache Geode & Pivotal GemFire aims to provide developers with a consistent experience +whether building and running Spring Boot, Apache Geode/Pivotal GemFire applications locally or in a managed environment, such as with https://pivotal.io/platform[Pivotal CloudFoundry] (PCF). -This project is a continuation and logical extension to Spring Data for Apache Geode/Pivotal GemFire's -{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* +This project is a continuation and a logical extension to Spring Data for Apache Geode/Pivotal GemFire's +{spring-data-geode-docs-html}/#bootstrap-annotation-config[Annotation-based configuration model] and the goals +set forth in that model: _To 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 this very {spring-data-geode-docs-html}/#bootstrap-annotation-config[foundation] cemented in Spring Data for Apache Geode/Pivotal GemFire (SDG footnoteref:[SDG, Spring Data for Apache Geode and Spring Data for Pivotal GemFire are commonly known as SDG.]) -since the Spring Data *Kay* Release Train. +since the Spring Data Kay Release Train. [[introduction]] == Introduction @@ -67,7 +67,7 @@ since the Spring Data *Kay* Release Train. Spring Boot for Apache Geode & Pivotal GemFire automatically applies _auto-configuration_ to several key application concerns (_Use Cases_) including, but not limited to: -* _Look-Aside Caching_, using either Apache Geode or Pivotal GemFire as the caching provider in +* _Look-Aside Caching_, using either Apache Geode or Pivotal GemFire as a caching provider in {spring-framework-docs}/integration.html#cache[Spring's Cache Abstraction]. * {wikipedia-docs}/System_of_record[_System of Record_ (SOR)], persisting application state reliably in Apache Geode or Pivotal GemFire using {spring-data-commons-docs-html}/#repositories[Spring Data Repositories]. @@ -79,9 +79,9 @@ and {spring-data-geode-docs-html}/#apis:global-transaction-management[Global JTA and conveniently implemented and executed with SDGfootnoteref:[SDG] {spring-data-geode-docs-html}/#function-annotations[POJO-based, annotation support for Functions]. * _Continuous Queries_, expressing interests in a stream of events, where applications are able to react to and process changes to data in near real-time using Apache Geode/Pivotal GemFire {apache-geode-docs}/developing/continuous_querying/chapter_overview.html[Continuous Query (CQ)]. -Handlers are defined in simple Message-Driven POJOs (MDP) using Spring's {spring-framework-docs}/integration.html#jms-mdp[Message Listener Container], -which has been {spring-data-geode-docs-html}/#apis:continuous-query[extended] in, and is {spring-data-geode-docs-html}/#bootstrap-annotation-config-continuous-queries[configurable] -using SDGfootnoteref:[SDG] CQ support. +Handlers are defined as simple Message-Driven POJOs (MDP) using Spring's {spring-framework-docs}/integration.html#jms-mdp[Message Listener Container], +which has been {spring-data-geode-docs-html}/#apis:continuous-query[extended] by SDGfootnoteref:[SDG] with its +{spring-data-geode-docs-html}/#bootstrap-annotation-config-continuous-queries[configurable] CQ support. * _Data Serialization_ with Apache Geode/Pivotal GemFire {apache-geode-docs}/developing/data_serialization/gemfire_pdx_serialization.html[PDX], including first-class {spring-data-geode-docs-html}/#bootstrap-annotation-config-pdx[configuration] and {spring-data-geode-docs-html}/#mapping.pdx-serializer[support] in SDGfootnoteref:[SDG]. @@ -90,10 +90,12 @@ and {spring-data-geode-docs-html}/#mapping.pdx-serializer[support] in SDGfootnot using Apache Geode/Pivotal GemFire's {apache-geode-docs}/managing/security/ssl_overview.html[Secure Socket Layer (SSL)]. Once again, SDGfootnoteref:[SDG] includes first-class support for configuring {spring-data-geode-docs-html}/#bootstrap-annotation-config-security[Auth] and {spring-data-geode-docs-html}/#bootstrap-annotation-config-ssl[SSL]. +* _HTTP Session state management_, by including Spring Session for Apache Geode/Pivotal GemFire on your application's +classpath. -While Spring Data for Apache Geode & Pivotal GemFire offers a simple, very convenient and declarative approach -to configure all these extremely powerful Apache Geode/Pivotal GemFire features, Spring Boot for Apache Geode -& Pivotal Gemfire makes this even easier to do as we will explore throughout this Reference Guide. +While Spring Data for Apache Geode & Pivotal GemFire offers a simple, convenient and declarative approach to configure +all these powerful Apache Geode/Pivotal GemFire features, Spring Boot for Apache Geode & Pivotal Gemfire makes it even +easier to do as we will explore throughout this Reference Documentation. [[getting-started]] == Getting Started @@ -108,20 +110,21 @@ Then, our journey continues with the extensions built into Spring Data for Apach (SDGfootnoteref:[SDG, Spring Data for Apache Geode and Spring Data for Pivotal GemFire are commonly known as SDG.]) to truly simplify the development of Apache Geode & Pivotal GemFire applications in a Spring context, using Spring's powerful abstractions and highly consistent programming model. This part of the story was greatly enhanced in -Spring Data *Kay*, with the SDGfootnoteref:[SDG] {spring-data-geode-docs-html}/#bootstrap-annotation-config[annotation-based configuration model]. +Spring Data Kay, with the SDGfootnoteref:[SDG] {spring-data-geode-docs-html}/#bootstrap-annotation-config[Annotation-based configuration model]. Though this new configuration approach using annotations provides sensible defaults out-of-the-box, its use -is also very explicit and assumes nothing. That is, you still must tell SDGfootnoteref:[SDG] what you want. +is also very explicit and assumes nothing. If any part of the configuration is ambiguous, SDG will fail fast. +SDG gives you "_choice_", so you still must tell SDGfootnoteref:[SDG] what you want. Next, we venture into Spring Boot and all of its wonderfully expressive and highly opinionated "_convention over configuration_" -approach for getting the most out of your Spring, Apache Geode/Pivotal GemFire based applications in the quickest/easiest way -possible. We accomplish this by combining Spring Data for Apache Geode/Pivotal GemFire's -{spring-data-geode-docs-html}/#bootstrap-annotation-config[annotation-based configuration] with Spring Boot's +approach for getting the most out of your Spring, Apache Geode/Pivotal GemFire based applications in the easiest, +quickest and most reliable way possible. We accomplish this by combining Spring Data for Apache Geode/Pivotal GemFire's +{spring-data-geode-docs-html}/#bootstrap-annotation-config[Annotation-based configuration] with Spring Boot's {spring-boot-docs-html}/#using-boot-auto-configuration[auto-configuration] to get you up and running 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 {spring-boot-docs-html}/#getting-started[here]. -Finally, we arrive at Spring Boot for Apache Geode & Pivotal GemFire. +Finally, we arrive at Spring Boot for Apache Geode & Pivotal GemFire (SBDG). [[maven-gradle]] == Using Spring Boot for Apache Geode and Pivotal GemFire