DATAES-120 - Polished reference documentation.

This commit is contained in:
Oliver Gierke 2014-08-22 15:23:28 +02:00
parent 479a670e2f
commit c866664acc
2 changed files with 23 additions and 11 deletions

View File

@ -1,28 +1,35 @@
= Spring Data Elasticsearch = Spring Data Elasticsearch
BioMed Central Development Team BioMed Central Development Team
:revnumber: {version}
:revdate: {localdate}
:toc: :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[] include::preface.adoc[]
:leveloffset: +1
include::{spring-data-commons-docs}/repositories.adoc[]
:leveloffset: -1
[[reference]] [[reference]]
= Reference Documentation = Reference Documentation
:leveloffset: 1 :leveloffset: +1
include::{spring-data-commons-docs}/repositories.adoc[]
include::reference/data-elasticsearch.adoc[] include::reference/data-elasticsearch.adoc[]
include::reference/elasticsearch-misc.adoc[] include::reference/elasticsearch-misc.adoc[]
:leveloffset: -1
:leveloffset: 0
:numbered!:
[[appendix]] [[appendix]]
= Appendix = Appendix
:numbered!:
:leveloffset: +1
include::{spring-data-commons-docs}/repository-namespace-reference.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-keywords-reference.adoc[]
:leveloffset: -1

View File

@ -1,14 +1,19 @@
[preface]
= 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. 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]] [[project]]
[preface]
== Project Metadata == 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]] [[requirements]]
[preface]
== Requirements == 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 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