DATAGRAPH-931 - Document new features.

pom.xml

@@ -27,7 +27,7 @@
         <project.type>multi</project.type>
         <dist.id>spring-data-neo4j</dist.id>
         <springdata.commons>1.13.0.BUILD-SNAPSHOT</springdata.commons>
-        <source.level>1.7</source.level>
+        <source.level>1.8</source.level>
     </properties>
 
     <developers>
@@ -180,6 +180,7 @@
         </profile>
     </profiles>
 
+
     <repositories>
         <repository>
             <id>neo4j</id>

spring-data-neo4j/pom.xml

@@ -164,6 +164,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-failsafe-plugin</artifactId>
+                <version>2.19.1</version>
                 <executions>
                     <execution>
                         <id>integration-test</id>

src/main/asciidoc/faq.adoc

@@ -0,0 +1,8 @@
+[[faq]]
+[appendix]
+= Frequently asked questions
+
+[qanda]
+What is the difference between Neo4j OGM and Spring Data Neo4j (SDN)?::
+  Spring Data Neo4j (SDN) uses the OGM under the covers. It's like Spring Data JPA, where JPA/Hibernate underly it.  Most
+  of the power of SDN actually comes from the OGM.

src/main/asciidoc/foreword.adoc

@@ -1,3 +1,6 @@
+[[forward]]
+= Foreword
+
 [quote, Rod Johnson, Founder of the Spring Framework]
 ____
 I’m excited about Spring Data Neo4j for several reasons.

src/main/asciidoc/index.adoc

@@ -1,83 +1,76 @@
-= Good Relationships: The Spring Data Neo4j Guide Book
+= Spring Data Neo4j - Reference Documentation
 Michael Hunger; Oliver Gierke; Vince Bickers; Adam George; Luanne Misquitta; Michal Bachman; Mark Angrish
-:toc:
-:toc-placement!:
 :revnumber: {version}
 :revdate: {localdate}
-
-Spring Data Neo4j Version 4.2.0.RC1 (December 2016)
+:toc:
+:toc-placement!:
+:spring-data-commons-docs: ../../../../spring-data-commons/src/main/asciidoc
 
 (C) 2010-2016 Graph Aware Ltd - Neo Technology, Inc. - Pivotal Software, Inc.
 
-NOTE: Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee
-for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
-
-toc::[]
-
-image::springdatagraph.png[Spring + Neo4j,align="center"]
-
-[[forward]]
-= Foreword
-
-:sectnums!:
-
-include::foreword.adoc[]
-
-:sectnums:
+image::springdatagraph.png[Spring + Neo4j,align="left"]
 
-[[preface]]
-= Preface
+NOTE: _Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically._
 
-:sectnums!:
+toc::[]
 
 include::preface.adoc[]
 
-:sectnums:
-
-[[introduction]]
-= Introduction
-
 :leveloffset: +1
-
-include::introduction/spring-data.adoc[]
-include::introduction/neo4j.adoc[]
-
+include::new-features.adoc[]
+include::{spring-data-commons-docs}/dependencies.adoc[]
+include::{spring-data-commons-docs}/repositories.adoc[]
 :leveloffset: -1
 
 [[reference]]
 = Reference Documentation
 
 :leveloffset: +1
-
 include::reference/overview.adoc[]
-include::reference/requirements.adoc[]
-include::reference/release-train.adoc[]
 include::reference/architecture.adoc[]
 include::reference/setup.adoc[]
-include::reference/programming-model/programming-model.adoc[]
+include::reference/neo4j-repositories.adoc[]
+include::reference/neo4j-template.adoc[]
 include::reference/performance.adoc[]
-include::reference/ha.adoc[]
-
+include::reference/migration.adoc[]
 :leveloffset: -1
 
-[[migration]]
-= Migration Guide
 
-:leveloffset: +1
+[[ogm-reference-documentation]]
+= Neo4j OGM Reference Documentation
 
-include::migration/migration.adoc[]
+[abstract]
+--
+This chapter is the reference documentation for Neo4j OGM, taken from the http://neo4j.com/docs/ogm-manual/current[Official Neo4j OGM Reference Documentation] to
+help developers understand the underlying mapping technology in Spring Data Neo4j.
+It covers the programming model, APIs, concepts, annotations and technical details of the Neo4j OGM.
+--
 
+:leveloffset: +1
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/introduction.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/getting-started.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/configuration.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/annotations.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/indexing.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/connecting.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/session.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/conversion.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/filters.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/events.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/testing.adoc[]
+include::https://raw.githubusercontent.com/neo4j/neo4j-ogm/master/neo4j-ogm-docs/src/main/asciidoc/reference/ha.adoc[]
 :leveloffset: -1
+`
 
 [[appendix]]
 = Appendix
 
 :numbered!:
-
 :leveloffset: +1
-
-include::appendix/appendix.adoc[]
+include::{spring-data-commons-docs}/repository-namespace-reference.adoc[]
+include::{spring-data-commons-docs}/repository-populator-namespace-reference.adoc[]
+include::{spring-data-commons-docs}/repository-query-keywords-reference.adoc[]
+include::{spring-data-commons-docs}/repository-query-return-types-reference.adoc[]
+include::faq.adoc[]
 
 :leveloffset: -1
-
-:numbered:

src/main/asciidoc/new-features.adoc

@@ -0,0 +1,19 @@
+[[new-features]]
+= New & Noteworthy
+
+[[new-features.4-2-0]]
+== What's new in Spring Data Neo4j 4.2.0
+* Upgrade to Neo4j OGM 2.1.1.
+* Support for Neo4j 3.1.0.
+* Improved documentation focusing more on Spring.
+* Support for other repository query keywords available in Spring Data.
+* Support sorting in derived repository query methods.
+* Support for countBy and delete/removeBy in derived finders.
+* All Cypher Exceptions now translated to Spring Data Exception hierarchy.
+* Fixed `MetaDataDrivenConversionService` to compile against Spring Framework 4.3.
+* Better compliance with Spring's Transaction Manager.
+* Support `@Depth` param on derived repository query methods.
+* Support paging and sorting for custom queries.
+* Improved support for Spring Data REST.
+* Support for findByPropertyNear.
+