Spring/spring-data-geode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Asciidoc configuration and references.

Browse Source 
Resolves #623.
This commit is contained in:
John Blum
2022-09-26 13:44:32 -07:00
parent 2e674202ff
commit d9b7cc9709
10 changed files with 64 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spring-data-geode-docs/spring-data-geode-docs.gradle
View File

@@ -23,7 +23,9 @@ asciidoctor {
clearSources()
sources {
include "index.adoc"
include "guides/*.adoc"
include "appendix/*.adoc"
include "introduction/*.adoc"
include "reference/*.adoc"
}
}

4
spring-data-geode-docs/src/docs/asciidoc/appendix/appendix-schema.adoc
View File

@@ -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)]

67
spring-data-geode-docs/src/docs/asciidoc/index.adoc
View File

@@ -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]

2
spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap-annotations.adoc
View File

@@ -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]

24
spring-data-geode-docs/src/docs/asciidoc/reference/bootstrap.adoc
View File

@@ -56,11 +56,11 @@ as the following example shows:
----
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:gfe="{spring-data-schema-namespace}" <!--1--><!--2-->
xmlns:gfe="{spring-geode-schema-namespace}" <!--1--><!--2-->
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} <!--3-->
{spring-geode-schema-namespace} {spring-geode-schema-location} <!--3-->
">
<bean id ... >
@@ -85,12 +85,12 @@ shown earlier, as the following example shows:
[subs="verbatim,attributes"]
----
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="{spring-data-schema-namespace}" <!--1-->
<beans xmlns="{spring-geode-schema-namespace}" <!--1-->
xmlns:beans="http://www.springframework.org/schema/beans" <!--2-->
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}
">
<beans:bean id ... > <!--3-->
@@ -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]

8
spring-data-geode-docs/src/docs/asciidoc/reference/cache.adoc
View File

@@ -61,12 +61,12 @@ or load properties from a properties file, as follows:
----
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:gfe="{spring-data-schema-namespace}"
xmlns:gfe="{spring-geode-schema-namespace}"
xmlns:util="http://www.springframework.org/schema/util"
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}
http://www.springframework.org/schema/util https://www.springframework.org/schema/util/spring-util.xsd
">
@@ -254,12 +254,12 @@ allowing complete configuration through the Spring container, as the following e
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:gfe="{spring-data-schema-namespace}"
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
http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd
{spring-data-schema-namespace} {spring-data-schema-location}
{spring-geode-schema-namespace} {spring-geode-schema-location}
">
<gfe:cache/>

4
spring-data-geode-docs/src/docs/asciidoc/reference/cq-container.adoc
View File

@@ -87,11 +87,11 @@ between the contract and the implementation.
----
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:gfe="{spring-data-schema-namespace}"
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}
">
<gfe:client-cache/>

10
spring-data-geode-docs/src/docs/asciidoc/reference/data.adoc
View File

@@ -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:
----
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:cache="http://www.springframework.org/schema/cache"
xmlns:gfe="{spring-data-schema-namespace}"
xmlns:gfe="{spring-geode-schema-namespace}"
xmlns:p="http://www.springframework.org/schema/p"
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
http://www.springframework.org/schema/cache https://www.springframework.org/schema/cache/spring-cache.xsd
{spring-data-schema-namespace} {spring-data-schema-location}
{spring-geode-schema-namespace} {spring-geode-schema-location}
">
<!-- enable declarative caching -->
@@ -686,13 +686,13 @@ XML:
----
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:cache="http://www.springframework.org/schema/cache"
xmlns:gfe="{spring-data-schema-namespace}"
xmlns:gfe="{spring-geode-schema-namespace}"
xmlns:p="http://www.springframework.org/schema/p"
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
http://www.springframework.org/schema/cache https://www.springframework.org/schema/cache/spring-cache.xsd
{spring-data-schema-namespace} {spring-data-schema-location}
{spring-geode-schema-namespace} {spring-geode-schema-location}
">
<!-- enable declarative caching -->

4
spring-data-geode-docs/src/docs/asciidoc/reference/region.adoc
View File

@@ -607,11 +607,11 @@ metadata as follows:
----
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:gfe="{spring-data-schema-namespace}"
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}
">
<gfe:cache cache-xml-location="classpath:cache.xml"/>

4
spring-data-geode-docs/src/docs/asciidoc/reference/repositories.adoc
View File

@@ -17,11 +17,11 @@ as the following example shows:
[subs="verbatim,attributes"]
----
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:gfe-data="{spring-data-access-schema-namespace}"
xmlns:gfe-data="{spring-data-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-access-schema-namespace} {spring-data-access-schema-location}
{spring-data-geode-schema-namespace} {spring-data-geode-schema-location}
">
<gfe-data:repositories base-package="com.example.acme.repository"/>