Description
Jens Schauder opened DATACMNS-1086 and commented
Currently, the reference documentation of the different Spring Data modules consists of two parts:
A preface pulled Spring Data Commons plus a store specific section. This leads topics being spread across the two parts, making the documentation hard to read. Also in some instances fixed store specific examples are used in the generic part, making it appear in the documentation of different modules as well.
Ultimately we want to achieve a documentation that
- reads as a single well-structured document, where each topic is covered in a single place.
- has the same basic structure for all stores.
- is easy to maintain by developers for which writing documentation isn't the prime focus.
- a migration from the current structure to the new structure should be possible store by store and possibly section by section, without breaking other stores while doing no or only minimal changes to their documentation.
For this issue, the planned new structure should be implemented for the topic "Query Methods" across all modules. This means:
- The generic section about "Query Methods" should appear only in the store specific section of the documentation.
- It should contain both the generic information and the store specific information.
- It should not contain references to other modules
- It should become obvious how the over-all goals outlined above can be achieved.
The following lists the current version of the documentation. Each contains a link to the respective Github repository.
Generic part (in the JPA documentation, appears also for the other stores
http://docs.spring.io/spring-data/jpa/docs/2.0.0.M3/reference/html/#repositories.query-methods.details
Store specific parts
JPA: http://docs.spring.io/spring-data/jpa/docs/2.0.0.M3/reference/html/#jpa.query-methods
Solr: http://docs.spring.io/spring-data/solr/docs/3.0.0.M3/reference/html/#solr.query-methods
Elastic Search: http://docs.spring.io/spring-data/elasticsearch/docs/3.0.0.M3/reference/html/#elasticsearch.query-methods
The following documents should not be affected by the change. They are for further stores, that currently deviate strongly from the structure of the other stores:
http://docs.spring.io/spring-data-gemfire/docs/2.0.0.M3/reference/html/
http://docs.spring.io/spring-data/ldap/docs/2.0.0.M3/reference/html/#ldap.repositories.queries
http://docs.spring.io/spring-data/rest/docs/3.0.0.M3/reference/html/
http://docs.spring.io/spring-data/redis/docs/2.0.0.M3/reference/html/
http://docs.spring.io/spring-data/data-neo4j/docs/5.0.0.M3/reference/html/#repositories.query-methods
Issue Links:
- DATAJPA-1127 Improve documentation to clearly state that Query By Example ignores collections