diff --git a/spring-data-geode-docs/spring-data-geode-docs.gradle b/spring-data-geode-docs/spring-data-geode-docs.gradle index 83ef67b9..2a457ef0 100644 --- a/spring-data-geode-docs/spring-data-geode-docs.gradle +++ b/spring-data-geode-docs/spring-data-geode-docs.gradle @@ -23,7 +23,9 @@ asciidoctor { clearSources() sources { include "index.adoc" - include "guides/*.adoc" + include "appendix/*.adoc" + include "introduction/*.adoc" + include "reference/*.adoc" } } diff --git a/spring-data-geode-docs/src/docs/asciidoc/appendix/appendix-schema.adoc b/spring-data-geode-docs/src/docs/asciidoc/appendix/appendix-schema.adoc index 1c68ca7e..4a72cf50 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/appendix/appendix-schema.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/appendix/appendix-schema.adoc @@ -2,5 +2,5 @@ [appendix] = {sdg-name} Schema -* {spring-data-schema-location}[{sdg-name} Core Schema (`gfe` XML namespace)] -* {spring-data-access-schema-location}[{sdg-name} Data Access Schema (`gfe-data` XML namespace)] +* {spring-geode-schema-location}[{sdg-name} Core Schema (`gfe` XML namespace)] +* {spring-data-geode-schema-location}[{sdg-name} Data Access Schema (`gfe-data` XML namespace)] diff --git a/spring-data-geode-docs/src/docs/asciidoc/index.adoc b/spring-data-geode-docs/src/docs/asciidoc/index.adoc index 02b737fa..5e14f302 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/index.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/index.adoc @@ -1,38 +1,33 @@ = Spring Data for {data-store-name} Reference Guide -Costin Leau; David Turanski; John Blum; Oliver Gierke; Jay Bryant +Costin Leau; David Turanski; John Blum; Oliver Drotbohm; Jay Bryant :revdate: {localdate} :revnumber: {version} :toclevels: 2 -:apache-geode-version: 19 -:apache-geode-docs: https://geode.apache.org/docs/guide/{apache-geode-version} +:apache-geode-version: 115 +:apache-geode-docs: https://geode.apache.org/docs/guide/{apache-geode-version}/about_geode.html :apache-geode-javadoc: https://geode.apache.org/releases/latest/javadoc :apache-geode-website: https://geode.apache.org :apache-geode-wiki: https://cwiki.apache.org/confluence/display/GEODE -:data-store-name-symbolic: geode :data-store-name-simple: Geode +:data-store-name-symbolic: geode :data-store-name: Apache {data-store-name-simple} -:data-store-version: 1.9.0 -:pivotal-gemfire-version: 98 -:pivotal-gemfire-docs: https://gemfire.docs.pivotal.io/{pivotal-gemfire-version} -:pivotal-gemfire-javadoc: https://gemfire-{pivotal-gemfire-version}-javadocs.docs.pivotal.io/ -:pivotal-gemfire-website: https://pivotal.io/pivotal-gemfire -:pivotal-gemfire-wiki: https://cwiki.apache.org/confluence/display/GEODE +:data-store-version: 1.15.0 :sdg-acronym: SDG :sdg-javadoc: https://docs.spring.io/spring-data/{data-store-name-symbolic}/docs/current/api :sdg-name: Spring Data for {data-store-name} -:sdg-website: https://projects.spring.io/spring-data-gemfire -:spring-data-access-schema-location: https://www.springframework.org/schema/data/geode/spring-data-geode.xsd -:spring-data-access-schema-namespace: https://www.springframework.org/schema/data/geode -:spring-data-commons-docs: https://docs.spring.io/spring-data/commons/docs/current/reference -:spring-data-commons-include: ../../../../spring-data-commons/src/main/asciidoc -:spring-data-commons-docs-html: {spring-data-commons-docs}/html -:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api -:spring-data-schema-location: https://www.springframework.org/schema/geode/spring-geode.xsd -:spring-data-schema-namespace: https://www.springframework.org/schema/geode +:sdg-website: https://projects.spring.io/spring-data-geode :spring-data-website: https://spring.io/projects/spring-data +: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-commons-include: ../../../../spring-data-commons/src/main/asciidoc +:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api +:spring-data-geode-schema-location: https://www.springframework.org/schema/data/geode/spring-data-geode.xsd +:spring-data-geode-schema-namespace: https://www.springframework.org/schema/data/geode :spring-framework-docs: https://docs.spring.io/spring/docs/current/spring-framework-reference :spring-framework-javadoc: https://docs.spring.io/spring/docs/current/javadoc-api :spring-framework-website: https://spring.io/projects/spring-framework +:spring-geode-schema-location: https://www.springframework.org/schema/geode/spring-geode.xsd +:spring-geode-schema-namespace: https://www.springframework.org/schema/geode :x-data-store-docs: {apache-geode-docs} :x-data-store-javadoc: {apache-geode-javadoc} :x-data-store-website: {apache-geode-website} @@ -46,26 +41,26 @@ charge any fee for such copies and further provided that each copy contains this whether distributed in print or electronically. [[preface]] -include::{basedocdir}/preface.adoc[] +include::preface.adoc[] -include::{basedocdir}/introduction/introduction.adoc[leveloffset=+1] -include::{basedocdir}/introduction/requirements.adoc[leveloffset=+1] -include::{basedocdir}/introduction/new-features.adoc[leveloffset=+1] +include::introduction/introduction.adoc[leveloffset=+1] +include::introduction/requirements.adoc[leveloffset=+1] +include::introduction/new-features.adoc[leveloffset=+1] [[reference]] = Reference Guide -include::{basedocdir}/reference/introduction.adoc[leveloffset=+1] -include::{basedocdir}/reference/bootstrap.adoc[leveloffset=+1] -include::{basedocdir}/reference/bootstrap-annotations.adoc[leveloffset=+1] -include::{basedocdir}/reference/data.adoc[leveloffset=+1] -include::{basedocdir}/reference/serialization.adoc[leveloffset=+1] -include::{basedocdir}/reference/mapping.adoc[leveloffset=+1] -include::{basedocdir}/reference/repositories.adoc[leveloffset=+1] -include::{basedocdir}/reference/function-annotations.adoc[leveloffset=+1] -include::{basedocdir}/reference/lucene.adoc[leveloffset=+1] -include::{basedocdir}/reference/gemfire-bootstrap.adoc[leveloffset=+1] -include::{basedocdir}/reference/samples.adoc[leveloffset=+1] +include::reference/introduction.adoc[leveloffset=+1] +include::reference/bootstrap.adoc[leveloffset=+1] +include::reference/bootstrap-annotations.adoc[leveloffset=+1] +include::reference/data.adoc[leveloffset=+1] +include::reference/serialization.adoc[leveloffset=+1] +include::reference/mapping.adoc[leveloffset=+1] +include::reference/repositories.adoc[leveloffset=+1] +include::reference/function-annotations.adoc[leveloffset=+1] +include::reference/lucene.adoc[leveloffset=+1] +include::reference/gemfire-bootstrap.adoc[leveloffset=+1] +include::reference/samples.adoc[leveloffset=+1] [[resources]] = Resources @@ -74,7 +69,7 @@ In addition to this reference documentation, there are a number of other resourc how to use {data-store-product-name} with the _Spring Framework_. These additional, third-party resources are enumerated in this section. -include::{basedocdir}/links.adoc[leveloffset=+1] +include::links.adoc[leveloffset=+1] [[appendices]] = Appendices @@ -84,4 +79,4 @@ include::{spring-data-commons-include}/repository-namespace-reference.adoc[level include::{spring-data-commons-include}/repository-populator-namespace-reference.adoc[leveloffset=+1] include::{spring-data-commons-include}/repository-query-keywords-reference.adoc[leveloffset=+1] include::{spring-data-commons-include}/repository-query-return-types-reference.adoc[leveloffset=+1] -include::{basedocdir}/appendix/appendix-schema.adoc[leveloffset=+1] +include::appendix/appendix-schema.adoc[leveloffset=+1] diff --git a/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap-annotations.adoc b/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap-annotations.adoc index 39c3c308..a79919a3 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap-annotations.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap-annotations.adoc @@ -2441,4 +2441,4 @@ as _quickly_ and as _easily_ as possible, especially during development. We hope you will enjoy these new capabilities! -include::{basedocdir}/reference/bootstrap-annotations-quickstart.adoc[leveloffset=+1] +include::reference/bootstrap-annotations-quickstart.adoc[leveloffset=+1] diff --git a/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap.adoc b/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap.adoc index 8b309442..86966be7 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap.adoc @@ -56,11 +56,11 @@ as the following example shows: ---- + xmlns:gfe="{spring-geode-schema-namespace}" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd - {spring-data-schema-namespace} {spring-data-schema-location} + {spring-geode-schema-namespace} {spring-geode-schema-location} "> @@ -85,12 +85,12 @@ shown earlier, as the following example shows: [subs="verbatim,attributes"] ---- - + xmlns:beans="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd - {spring-data-schema-namespace} {spring-data-schema-location} + {spring-geode-schema-namespace} {spring-geode-schema-location} "> @@ -105,11 +105,11 @@ shown earlier, as the following example shows: <4> Bean declaration using the `gfe` namespace. Notice the lack of prefix since `gfe` is the default namespace. ==== -include::{basedocdir}/reference/data-access.adoc[leveloffset=+1] -include::{basedocdir}/reference/cache.adoc[leveloffset=+1] -include::{basedocdir}/reference/region.adoc[leveloffset=+1] -include::{basedocdir}/reference/indexing.adoc[leveloffset=+1] -include::{basedocdir}/reference/diskstore.adoc[leveloffset=+1] -include::{basedocdir}/reference/snapshot.adoc[leveloffset=+1] -include::{basedocdir}/reference/function.adoc[leveloffset=+1] -include::{basedocdir}/reference/gateway.adoc[leveloffset=+1] +include::reference/data-access.adoc[leveloffset=+1] +include::reference/cache.adoc[leveloffset=+1] +include::reference/region.adoc[leveloffset=+1] +include::reference/indexing.adoc[leveloffset=+1] +include::reference/diskstore.adoc[leveloffset=+1] +include::reference/snapshot.adoc[leveloffset=+1] +include::reference/function.adoc[leveloffset=+1] +include::reference/gateway.adoc[leveloffset=+1] diff --git a/spring-data-geode-docs/src/docs/asciidoc/reference/cache.adoc b/spring-data-geode-docs/src/docs/asciidoc/reference/cache.adoc index e2227988..e21e62b2 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/reference/cache.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/reference/cache.adoc @@ -61,12 +61,12 @@ or load properties from a properties file, as follows: ---- @@ -254,12 +254,12 @@ allowing complete configuration through the Spring container, as the following e diff --git a/spring-data-geode-docs/src/docs/asciidoc/reference/cq-container.adoc b/spring-data-geode-docs/src/docs/asciidoc/reference/cq-container.adoc index c4f444af..efcc0abc 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/reference/cq-container.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/reference/cq-container.adoc @@ -87,11 +87,11 @@ between the contract and the implementation. ---- diff --git a/spring-data-geode-docs/src/docs/asciidoc/reference/data.adoc b/spring-data-geode-docs/src/docs/asciidoc/reference/data.adoc index cd2d0759..d964edc7 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/reference/data.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/reference/data.adoc @@ -418,7 +418,7 @@ See the *note* above for more details. :leveloffset: +1 -include::{basedocdir}/reference/cq-container.adoc[] +include::reference/cq-container.adoc[] :leveloffset: -1 @@ -632,13 +632,13 @@ simply add `GemfireCacheManager` to your configuration: ---- @@ -686,13 +686,13 @@ XML: ---- diff --git a/spring-data-geode-docs/src/docs/asciidoc/reference/region.adoc b/spring-data-geode-docs/src/docs/asciidoc/reference/region.adoc index be4a552b..9212163e 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/reference/region.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/reference/region.adoc @@ -607,11 +607,11 @@ metadata as follows: ---- diff --git a/spring-data-geode-docs/src/docs/asciidoc/reference/repositories.adoc b/spring-data-geode-docs/src/docs/asciidoc/reference/repositories.adoc index bdbb297e..57b1ace2 100644 --- a/spring-data-geode-docs/src/docs/asciidoc/reference/repositories.adoc +++ b/spring-data-geode-docs/src/docs/asciidoc/reference/repositories.adoc @@ -17,11 +17,11 @@ as the following example shows: [subs="verbatim,attributes"] ----