Skip to content

Commit 0944d16

Browse files
authored
DATAES-842 - Documentation fixes.
Oriignal PR: spring-projects#494
1 parent 0f940b3 commit 0944d16

File tree

4 files changed

+13
-9
lines changed

4 files changed

+13
-9
lines changed

CI.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
= Continuous Integration
22

3-
image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2Fmaster&subject=Moore%20(master)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
4-
image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2F3.1.x&subject=Lovelace%20(3.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
5-
image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2F2.1.x&subject=Ingalls%20(2.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
3+
image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2Fmaster&subject=2020.0.0%20(master)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
4+
image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2F4.0.x&subject=Neumann%20(4.0.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
5+
image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2F3.2.x&subject=Moore%20(3.2.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
66

77
== Running CI tasks locally
88

README.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,10 @@ If you want to build with the regular `mvn` command, you will need https://maven
197197

198198
_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before submitting your first pull request._
199199

200+
IMPORTANT: When contributing, please make sure an issue exists in Jira and comment on this issue with how you want to address it. By this we not only know that someone is working on an issue, we can also align architectural questions and possible solutions before work is invested. We so can prevent that much work is put into Pull Requests that have little
201+
or no chances of being merged.
202+
203+
200204
=== Building reference documentation
201205

202206
Building the documentation builds also the project without running tests.

src/main/asciidoc/reference/elasticsearch-auditing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,18 @@ public class Person implements Persistable<Long> {
3737
private Instant lastModifiedDate;
3838
private String lastModifiedBy;
3939
40-
public Long getId() { <1>
40+
public Long getId() { // <.>
4141
return id;
4242
}
4343
4444
@Override
4545
public boolean isNew() {
46-
return id == null || (createdDate == null && createdBy == null); <2>
46+
return id == null || (createdDate == null && createdBy == null); // <.>
4747
}
4848
}
4949
----
50-
<1> the getter also is the required implementation from the interface
51-
<2> an object is new if it either has no `id` or none of fields containing creation attributes are set.
50+
<.> the getter is the required implementation from the interface
51+
<.> an object is new if it either has no `id` or none of fields containing creation attributes are set.
5252

5353
=== Activating auditing
5454

src/main/asciidoc/reference/elasticsearch-object-mapping.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The `MappingElasticsearchConverter` uses metadata to drive the mapping of object
2828
The following annotations are available:
2929

3030
* `@Document`: Applied at the class level to indicate this class is a candidate for mapping to the database. The most important attributes are:
31-
** `indexName`: the name of the index to store this entity in
31+
** `indexName`: the name of the index to store this entity in. This can contain a SpEL template expression like `"log-#{T(java.time.LocalDate).now().toString()}"`
3232
** `type`: [line-through]#the mapping type. If not set, the lowercased simple name of the class is used.# (deprecated since version 4.0)
3333
** `shards`: the number of shards for the index.
3434
** `replicas`: the number of replicas for the index.
@@ -48,7 +48,7 @@ The following annotations are available:
4848
** `analyzer`, `searchAnalyzer`, `normalizer` for specifying custom custom analyzers and normalizer.
4949
* `@GeoPoint`: marks a field as _geo_point_ datatype. Can be omitted if the field is an instance of the `GeoPoint` class.
5050

51-
NOTE: Properties that derive from `TemporalAccessor` must either have a `@Field` annotation of type `FieldType.Date` or a custom converter must be registerd for this type. +
51+
NOTE: Properties that derive from `TemporalAccessor` must either have a `@Field` annotation of type `FieldType.Date` or a custom converter must be registered for this type. +
5252
If you are using a custom date format, you need to use _uuuu_ for the year instead of _yyyy_. This is due to a https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-to-java-time.html#java-time-migration-incompatible-date-formats[change in Elasticsearch 7].
5353

5454
The mapping metadata infrastructure is defined in a separate spring-data-commons project that is technology agnostic.

0 commit comments

Comments
 (0)