Browse Source

working on the docs

pull/1/head
Thomas Risberg 15 years ago
parent
commit
4a9ed870d1
  1. 5
      src/docbkx/index.xml
  2. 34
      src/docbkx/reference/couchdb.xml
  3. 8
      src/docbkx/reference/introduction.xml
  4. 2
      src/docbkx/reference/mongo-repositories.xml
  5. 2
      src/docbkx/reference/mongodb.xml

5
src/docbkx/index.xml

@ -50,12 +50,13 @@ @@ -50,12 +50,13 @@
<xi:include href="https://github.com/SpringSource/spring-data-commons/raw/master/src/docbkx/repositories.xml" />
</part>
<part id="mongodb">
<title>Mongo DB</title>
<part id="reference">
<title>Reference Documentation</title>
<xi:include href="reference/introduction.xml"/>
<xi:include href="reference/mongodb.xml"/>
<xi:include href="reference/mongo-repositories.xml"/>
<!-- <xi:include href="reference/couchdb.xml"/> -->
</part>
</book>

34
src/docbkx/reference/couchdb.xml

@ -0,0 +1,34 @@ @@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="couch.core">
<title>CouchDB support</title>
<para>One of the document stores supported by DATADOC is <ulink
url="http://couchdb.apache.org/">CouchDB</ulink>.</para>
<section id="couchdb:requirements">
<title>CouchDB Requirements</title>
<para>DATADOC requires Couchdb version 1.0 or later.</para>
</section>
<section id="couchdb:architecture">
<title>CouchDB Support High Level View</title>
<para>The CouchDB support is still under development and not part of this release.</para>
</section>
<section id="couchdb:roadmap">
<title>Roadmap ahead</title>
<para>The Spring Data Document projects CouchDB support is in its early
stages. We are interested in feedback, knowing what your use cases are,
what are the common patters you encounter so that the CouchDB module
better serves your needs. Do contact us using the channels <link
linkend="get-started:help:community">mentioned</link> above, we are
interested in hearing from you!</para>
</section>
</chapter>

8
src/docbkx/reference/introduction.xml

@ -1,9 +1,13 @@ @@ -1,9 +1,13 @@
<partintro>
<title>Document structure</title>
<title>Document Structure</title>
<para>This part of the reference documentation explains the core functionality
offered by Spring Data Document.</para>
<para><xref linkend="mongodb"/> introduces the Document module feature set.</para>
<para><xref linkend="mongo.core"/> introduces the MongoDB module feature set.</para>
<para><xref linkend="mongo.repositories"/> introduces the repository support for MongoDB.</para>
<!-- <para><xref linkend="couch.core"/> introduces the CouchDB module feature set.</para> -->
</partintro>

2
src/docbkx/reference/mongo-repositories.xml

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter>
<chapter id="mongo.repositories">
<title>Mongo repositories</title>
<abstract>

2
src/docbkx/reference/mongodb.xml

@ -2,7 +2,7 @@ @@ -2,7 +2,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="mongo.core">
<title>Core support</title>
<title>MongoDB support</title>
<para>One of the document stores supported by DATADOC is <ulink
url="http://www.mongodb.org/">MongoDB</ulink>. To quote the project home

Loading…
Cancel
Save