From 1947da3b93b75ca24719f4fee9f9af5d1edf03ad Mon Sep 17 00:00:00 2001 From: Oliver Gierke Date: Fri, 22 Aug 2014 15:49:54 +0200 Subject: [PATCH] DATACASS-153 - Polished reference documentation. --- src/main/asciidoc/index.adoc | 26 ++++++++++--------- .../introduction/getting-started.adoc | 1 + src/main/asciidoc/preface.adoc | 11 ++++++++ 3 files changed, 26 insertions(+), 12 deletions(-) diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index b95909061..7657d7b4c 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -1,43 +1,45 @@ = Spring Data Cassandra - Reference Documentation David Webb, Matthew Adams +:revnumber: {version} +:revdate: {localdate} :toc: -:idprefix: +:toc-placement!: :spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/master/src/main/asciidoc -{version} +(C) 2008-2014 The original author(s). -(C) 2008-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._ - -[preface] +toc::[] include::preface.adoc[] -:leveloffset: 0 [[introduction]] = Introduction include::introduction/introduction.adoc[] -:leveloffset: 1 +:leveloffset: +1 include::introduction/requirements.adoc[] include::introduction/getting-started.adoc[] include::{spring-data-commons-docs}/repositories.adoc[] +:leveloffset: -1 -:leveloffset: 0 [[reference]] = Reference Documentation -:leveloffset: 1 +:leveloffset: +1 include::reference/introduction.adoc[] include::reference/cassandra.adoc[] include::reference/cassandra-repositories.adoc[] include::reference/mapping.adoc[] +:leveloffset: -1 -:leveloffset: 0 +[[appendix]] = Appendix :numbered!: -[appendix] +: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/introduction/getting-started.adoc b/src/main/asciidoc/introduction/getting-started.adoc index b0fab7f02..ee39d6d70 100644 --- a/src/main/asciidoc/introduction/getting-started.adoc +++ b/src/main/asciidoc/introduction/getting-started.adoc @@ -29,3 +29,4 @@ For information on the Spring Data Cassandra source code repository, nightly bui To follow developer activity look for the mailing list information on the Spring Data Cassandra homepage. If you encounter a bug or want to suggest an improvement, please create a ticket on the Spring Data issue https://jira.spring.io/browse/DATACASS[tracker]. + diff --git a/src/main/asciidoc/preface.adoc b/src/main/asciidoc/preface.adoc index 72ca86ac8..15700c2e5 100644 --- a/src/main/asciidoc/preface.adoc +++ b/src/main/asciidoc/preface.adoc @@ -2,3 +2,14 @@ = Preface The Spring Data Cassandra project applies core Spring concepts to the development of solutions using the Cassandra Columnar data store. We provide a "template" as a high-level abstraction for storing and querying documents. You will notice similarities to the JDBC support in the Spring Framework. + +[[project]] +[preface] +== Project Metadata + +* Version Control - https://github.com/spring-projects/spring-data-cassandra +* Bugtacker - https://jira.spring.io/browse/DATACASS +* Release repository - https://repo.springsource.org/libs-release +* Milestone repository - https://repo.springsource.org/libs-milestone +* Snapshot repository - https://repo.springsource.org/libs-snapshot +