Skip to content

Commit 135e521

Browse files
mp911dechristophstrobl
authored andcommitted
Polishing.
Add gitignore entry for build/ dir, update playbook and readme. Use current year property. See: #526
1 parent 28b6260 commit 135e521

File tree

5 files changed

+11
-10
lines changed

5 files changed

+11
-10
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ node_modules
1212
node
1313
package.json
1414
package-lock.json
15+
build/

README.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ If you'd rather like the latest snapshots of the upcoming major version, use our
8585
<dependency>
8686
<groupId>org.springframework.data</groupId>
8787
<artifactId>spring-data-keyvalue</artifactId>
88-
<version>${version}.BUILD-SNAPSHOT</version>
88+
<version>${version}-SNAPSHOT</version>
8989
</dependency>
9090
9191
<repository>
@@ -100,10 +100,10 @@ If you'd rather like the latest snapshots of the upcoming major version, use our
100100
Having trouble with Spring Data? We’d love to help!
101101

102102
* Check the
103-
https://docs.spring.io/spring-data/keyvalue/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/keyvalue/docs/current/api/[Javadocs].
103+
https://docs.spring.io/spring-data/keyvalue/reference/[reference documentation], and https://docs.spring.io/spring-data/keyvalue/docs/current/api/[Javadocs].
104104
* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
105105
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
106-
* If you are upgrading, check out the https://docs.spring.io/spring-data/keyvalue/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features.
106+
* If you are upgrading, check out the https://github.com/spring-projects/spring-data-commons/wiki#release-notes[release notes] for "`new and noteworthy`" features.
107107
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-keyvalue`].
108108
You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter].
109109
* Report bugs with Spring Data KeyValue via https://github.com/spring-projects/spring-data-keyvalue/issues[Github].
@@ -122,7 +122,7 @@ If you want to raise an issue, please follow the recommendations below:
122122
== Building from Source
123123

124124
You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].
125-
You also need JDK 1.8.
125+
You also need JDK 17.
126126

127127
[source,bash]
128128
----
@@ -142,7 +142,7 @@ Building the documentation builds also the project without running tests.
142142
$ ./mvnw clean install -Pantora
143143
----
144144

145-
The generated documentation is available from `target/antora/site/data-keyvalue/index.html`.
145+
The generated documentation is available from `target/antora/site/index.html`.
146146

147147
== Examples
148148

src/main/antora/antora-playbook.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ antora:
55
extensions:
66
- '@antora/collector-extension'
77
- require: '@springio/antora-extensions/root-component-extension'
8-
root_component_name: 'data-redis'
8+
root_component_name: 'data-keyvalue'
99
site:
1010
title: Spring Data KeyValue
11-
url: https://docs.spring.io/spring-data-keyvalue/reference/
11+
url: https://docs.spring.io/spring-data/keyvalue/reference/
1212
content:
1313
sources:
1414
- url: ./../../..

src/main/antora/modules/ROOT/nav.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
* xref:index.adoc[]
1+
* xref:index.adoc[Overview]
22
* xref:keyvalue.adoc[]
3-
** xref:keyvalue/template.adoc[]
3+
* xref:keyvalue/template.adoc[]
44
55
* xref:repositories.adoc[]
66
** xref:repositories/core-concepts.adoc[]

src/main/antora/resources/antora-resources/antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ prerelease: ${antora-component.prerelease}
33

44
asciidoc:
55
attributes:
6-
copyright-year: 2023
6+
copyright-year: ${current.year}
77
version: ${project.version}
88
springversionshort: ${spring.short}
99
springversion: ${spring}

0 commit comments

Comments
 (0)