Skip to content

Commit 77f9b34

Browse files
GH-2562 - Restructure documentation.
Especially pull up the parts explaining the differences between SDN6 and SDN+OGM, make the FAQ more visible and have only one appendix in one place. Closes #2562.
1 parent 73bb4b9 commit 77f9b34

20 files changed

+1590
-1595
lines changed

pom.xml

+1-13
Original file line numberDiff line numberDiff line change
@@ -781,25 +781,13 @@
781781
<version>${asciidoctorj-diagram.version}</version>
782782
</dependency>
783783
</dependencies>
784-
<configuration>
785-
<backend>html</backend>
786-
<doctype>book</doctype>
787-
<imagesDir>img</imagesDir>
788-
<sourceDirectory>${project.basedir}/src/main/asciidoc</sourceDirectory>
789-
<sourceDocumentName>index.adoc</sourceDocumentName>
790-
<sourceHighlighter>coderay</sourceHighlighter>
784+
<configuration combine.self="append">
791785
<attributes>
792-
<icons>font</icons>
793-
<toc>left</toc>
794-
<setanchors/>
795-
<idprefix/>
796-
<idseparator/>
797786
<spring-data-commons-docs>${spring-data-commons-docs.dir}</spring-data-commons-docs>
798787
</attributes>
799788
<requires>
800789
<require>asciidoctor-diagram</require>
801790
</requires>
802-
<outputDirectory>${project.build.docs}</outputDirectory>
803791
</configuration>
804792
</plugin>
805793
</plugins>

src/main/asciidoc/appendix/conversions.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[[conversions]]
22
= Conversions
33

4+
[[build-in.conversions]]
5+
== Built-in conversions
6+
47
We support a broad range of conversions out of the box.
58
Find the list of supported cypher types in the official drivers manual: https://neo4j.com/docs/driver-manual/current/cypher-values/[Working with Cypher values].
69

src/main/asciidoc/appendix/index.adoc

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
:leveloffset: +1
2-
31
[[sdn-appendix]]
4-
= Spring Data Neo4j Appendix
2+
[appendix]
3+
= Spring Data Neo4j
54

6-
:numbered!:
75
:leveloffset: +1
86

97
include::conversions.adoc[]
@@ -21,4 +19,3 @@ include::migrating.adoc[]
2119
include::build.adoc[]
2220

2321
:leveloffset: -1
24-
:leveloffset: -1

src/main/asciidoc/appendix/migrating.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ You're then ready to replace annotations:
125125
|No replacement, not needed
126126

127127
|`org.springframework.data.neo4j.annotation.QueryResult`
128-
|Use <<projections.sdn, projections>>; arbitrary result mapping not supported anymore
128+
|Use <<projections, projections>>; arbitrary result mapping not supported anymore
129129

130130
|===
131131

0 commit comments

Comments
 (0)