diff --git a/src/docbkx/introduction/getting-started.xml b/src/docbkx/introduction/getting-started.xml index d95579c0c..6a9e9e66c 100644 --- a/src/docbkx/introduction/getting-started.xml +++ b/src/docbkx/introduction/getting-started.xml @@ -1,121 +1,37 @@ +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> - Getting Started + Additional Help Resources Learning a new framework is not always straight forward. In this - section, we (the Spring Data team) tried to provide, what we think is, an - easy to follow guide for starting with Spring Data Document module. Of - course, feel free to create your own learning 'path' as you see fit and, if - possible, please report back any improvements to the documentation that can - help others. - - -
- First Steps - - As explained in, Spring - Data Document (DATADOC) provides integration between Spring framework and - document oriented data stores. Thus, it is important to become acquainted - with both of these frameworks (storages or environments depending on how - you want to name them). Throughout the DATADOC documentation, each section - provides links to resources relevant however, it is best to become - familiar with these topics beforehand. - - -
- Knowing Spring - - Spring Data uses heavily Spring framework's - core - - functionality, such as the - IoC - - container, - resource - - abstract or - AOP - - infrastructure. While it is not important to know the Spring APIs, - understanding the concepts behind them is. At a minimum, the idea behind - IoC should be familiar. These being said, the more knowledge one has - about the Spring, the faster she will pick up Spring Data Document. - Besides the very comprehensive (and sometimes disarming) documentation - that explains in detail the Spring Framework, there are a lot of - articles, blog entries and books on the matter - take a look at the - Spring framework - home page - - for - more information. In general, this should be the starting point for - developers wanting to try Spring Data Document. - -
- -
- Knowing NoSQL and Document stores - - NoSQL stores have taken the storage world by storm. It is a vast - domain with a plethora of solutions, terms and patterns (to make things - worth even the term itself has multiplemeanings). - While some of the principles are common, it is crucial that the user is - familiar to some degree with the stores supported by DATADOC. The best - way to get acquainted to this solutions is to read their documentation - and follow their examples - it usually doesn't take more then 5-10 - minutes to go through them and if you are coming from an RDMBS-only - background many times these exercises can be an eye opener. - -
- -
- Trying Out The Samples - - The DATADOC project is very young but there are some samples - available in the GitHub repository: - https://github.com/SpringSource/spring-data-document-examples. - -
-
+ section, we (the Spring Data team) tried to provide, what we think is, an + easy to follow guide for starting with Spring Data Document module. However, + if you encounter issues or you are just looking for an advice, feel free to + use one of the links below:
- Need Help? + Support - If you encounter issues or you are just looking for an advice, feel - free to use one of the links below: - + There are a few support options available:
Community Forum - The Spring Data - forum - - is a message board for all Spring Data (not just Document) users to - share information and help each other. Note that registration is needed - only - for posting. - + The Spring Data forum + is a message board for all Spring Data (not just Document) + users to share information and help each other. Note that registration + is needed only for posting.
Professional Support Professional, from-the-source support, with guaranteed response - time, is available fromSpringSource, the company - behind Spring Data and Spring. - + time, is available from SpringSource, the company + behind Spring Data and Spring.
@@ -123,32 +39,24 @@ Following Development For information on the Spring Data source code repository, nightly - builds and snapshot artifacts please see the Spring Data homepage. - + builds and snapshot artifacts please see the Spring Data homepage. You can help make Spring Data best serve the needs of the Spring - community by interacting with developers through the Spring Community - forums. - + community by interacting with developers through the Spring Community + forums. If you encounter a bug or want to suggest an improvement, please - create a ticket on the Spring Data issuetracker. - + create a ticket on the Spring Data issue tracker. To stay up to date with the latest news and announcements in the - Spring eco system, subscribe to the Spring CommunityPortal. - + Spring eco system, subscribe to the Spring Community Portal. - Lastly, you can follow the SpringSource Data - blog - - or - the project team on Twitter (SpringData) - + Lastly, you can follow the SpringSource Data blog or + the project team on Twitter (SpringData) diff --git a/src/docbkx/introduction/introduction.xml b/src/docbkx/introduction/introduction.xml index 3897413a6..0d51bbb1b 100644 --- a/src/docbkx/introduction/introduction.xml +++ b/src/docbkx/introduction/introduction.xml @@ -1,20 +1,79 @@ - +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> - - This document is the reference guide for Spring Data - Document Support. - It explains Document module concepts and semantics and the syntax for various - stores namespaces. - + This document is the reference guide for Spring Data - Document + Support. It explains Document module concepts and semantics and the syntax + for various stores namespaces. This section provides some basic + introduction to Spring and Document database. The rest of the document + refers only to Spring Data Document features and assumes the user is + familiar with document databases such as MongoDB and CouchDB as well as + Spring concepts.
+ Knowing Spring - For an introduction to document stores or Spring, or Spring Data examples, please refer to - - - this documentation refers only to Spring Data Document Support and - assumes the user is familiar with the document stores and Spring concepts. - + Spring Data uses heavily Spring framework's core + functionality, such as the IoC + container, resource + abstract or AOP + infrastructure. While it is not important to know the Spring + APIs, understanding the concepts behind them is. At a minimum, the idea + behind IoC should be familiar. These being said, the more knowledge one + has about the Spring, the faster she will pick up Spring Data Document. + Besides the very comprehensive (and sometimes disarming) documentation + that explains in detail the Spring Framework, there are a lot of + articles, blog entries and books on the matter - take a look at the + Spring framework home page for + more information. +
+ Knowing NoSQL and Document databases - + NoSQL stores have taken the storage world by storm. It is a vast + domain with a plethora of solutions, terms and patterns (to make things + worth even the term itself has multiple meanings). + While some of the principles are common, it is crucial that the user is + familiar to some degree with the stores supported by DATADOC. The best + way to get acquainted to this solutions is to read their documentation + and follow their examples - it usually doesn't take more then 5-10 + minutes to go through them and if you are coming from an RDMBS-only + background many times these exercises can be an eye opener. - \ No newline at end of file + The jumping off ground for learning about MongoDB is www.mongodb.org. Here is a list of + other useful resources. + + + + The online shell + provides a convenient way to interact with a MongoDB instance in + combination with the online tutorial. + + + + MongoDB Java + Language Center + + + + Several books + available for purchase + + + + Karl Seguin's online book: "The Little MongoDB + Book" + + + + +
+ diff --git a/src/docbkx/introduction/why-sd-doc.xml b/src/docbkx/introduction/why-sd-doc.xml index e76b769f5..ee9dd0ddb 100644 --- a/src/docbkx/introduction/why-sd-doc.xml +++ b/src/docbkx/introduction/why-sd-doc.xml @@ -1,25 +1,39 @@ +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> Why Spring Data - Document? - The Spring Framework is the leading full-stack Java/JEE - application framework. It provides a lightweight container and a - non-invasive programming model enabled by the use of dependency - injection, AOP, and portable service abstractions. + The Spring Framework is the leading full-stack Java/JEE application + framework. It provides a lightweight container and a non-invasive + programming model enabled by the use of dependency injection, AOP, and + portable service abstractions. + + NoSQL storages + provide an alternative to classical RDBMS for horizontal scalability and + speed. In terms of implementation, Document stores represent one of the most + popular types of stores in the NoSQL space. The document database supported + by Spring Data are MongoDB and CouchDB, though just MongoDB integration has + been released to date. + + The goal of the Spring Data Document (or DATADOC) framework is to + provide an extension to the Spring programming model that supports writing + applications that use Document databases. The Spring framework has always + promoted a POJO programming model with a strong emphasis on portability and + productivity. These values are caried over into Spring Data Document. - - NoSQL - storages provide an alternative to classical RDBMS for horizontal scalability - and speed. In terms of implementation, Document stores represent one of the - most popular types of stores in the NoSQL space. - - - The Spring Data Document (or DATADOC) framework makes it easy to - write Spring applications that use a Document store by eliminating the redundant - tasks and boiler place code required for interacting with the store through - Spring's excellent infrastructure support. - - \ No newline at end of file + Notable features that are used in Spring Data Document from the Spring + framework are the Features that particular, features from the Spring + framework that are used are the Conversion Service, JMX Exporters, portable + Data Access Exception hierarchy, Spring Expression Language, and Java based + IoC container configuration. The programming model follows the familiar + Spring 'template' style, so if you are familar with Spring template classes + such as JdbcTemplate, JmsTemplate, RestTemplate, you will feel right at + home. For example, MongoTemplate removes much of the boilerplate code you + would have to write when using the MongoDB driver to save POJOs as well as a + rich java based query interface to retrieve POJOs. The programming model + also offers a new Repository approach in which the Spring container will + provide an implementation of a Repository based soley off an interface + definition which can also include custom finder methods. +