From c866664acc08a8ca4da8e90a870bb69adf349f1b Mon Sep 17 00:00:00 2001 From: Oliver Gierke Date: Fri, 22 Aug 2014 15:23:28 +0200 Subject: [PATCH] DATAES-120 - Polished reference documentation. --- src/main/asciidoc/index.adoc | 25 ++++++++++++++++--------- src/main/asciidoc/preface.adoc | 9 +++++++-- 2 files changed, 23 insertions(+), 11 deletions(-) diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index df72c81f1..0b78d9899 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -1,28 +1,35 @@ = Spring Data Elasticsearch BioMed Central Development Team +:revnumber: {version} +:revdate: {localdate} :toc: -:spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/issue/DATACMNS-551/src/main/asciidoc +:toc-placement!: +:spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/master/src/main/asciidoc -{version} +(C) 2013-2014 The original author(s). -(C) 2013-2014 The original author(s) +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. -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::[] include::preface.adoc[] +:leveloffset: +1 +include::{spring-data-commons-docs}/repositories.adoc[] +:leveloffset: -1 [[reference]] = Reference Documentation -:leveloffset: 1 -include::{spring-data-commons-docs}/repositories.adoc[] +:leveloffset: +1 include::reference/data-elasticsearch.adoc[] include::reference/elasticsearch-misc.adoc[] +:leveloffset: -1 -:leveloffset: 0 -:numbered!: [[appendix]] = Appendix - +:numbered!: +:leveloffset: +1 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[] +:leveloffset: -1 diff --git a/src/main/asciidoc/preface.adoc b/src/main/asciidoc/preface.adoc index c6f958104..e1d2f8812 100644 --- a/src/main/asciidoc/preface.adoc +++ b/src/main/asciidoc/preface.adoc @@ -1,14 +1,19 @@ -[preface] = Preface The Spring Data Elasticsearch project applies core Spring concepts to the development of solutions using the Elasticsearch Search Engine. We have povided a "template" as a high-level abstraction for storing,querying,sorting and faceting documents. You will notice similarities to the Spring data solr and mongodb support in the Spring Framework. [[project]] +[preface] == Project Metadata -* Version Control - `git://github.com/BioMedCentralLtd/spring-data-elasticsearch.git` +* Version Control - https://github.com/spring-projects/spring-data-elasticsearch +* Bugtracker - https://jira.spring.io/browse/DATAES +* Release repository - https://repo.spring.io/libs-release +* Milestone repository - https://repo.spring.io/libs-milestone +* Snapshot repository - https://repo.spring.io/libs-snapshot [[requirements]] +[preface] == Requirements Requires http://www.elasticsearch.org/download/[Elasticsearch] 0.20.2 and above or optional dependency or not even that if you are using Embedded Node Client