From 135e5216bb0469e5b73ead6a7d7c2435f6dc92f9 Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Mon, 11 Sep 2023 08:54:33 +0200 Subject: [PATCH] Polishing. Add gitignore entry for build/ dir, update playbook and readme. Use current year property. See: #526 --- .gitignore | 1 + README.adoc | 10 +++++----- src/main/antora/antora-playbook.yml | 4 ++-- src/main/antora/modules/ROOT/nav.adoc | 4 ++-- src/main/antora/resources/antora-resources/antora.yml | 2 +- 5 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 0939e1d..220f50d 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,4 @@ node_modules node package.json package-lock.json +build/ diff --git a/README.adoc b/README.adoc index a20e489..5ac6164 100644 --- a/README.adoc +++ b/README.adoc @@ -85,7 +85,7 @@ If you'd rather like the latest snapshots of the upcoming major version, use our org.springframework.data spring-data-keyvalue - ${version}.BUILD-SNAPSHOT + ${version}-SNAPSHOT @@ -100,10 +100,10 @@ If you'd rather like the latest snapshots of the upcoming major version, use our Having trouble with Spring Data? We’d love to help! * Check the -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]. +https://docs.spring.io/spring-data/keyvalue/reference/[reference documentation], and https://docs.spring.io/spring-data/keyvalue/docs/current/api/[Javadocs]. * 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. If you are just starting out with Spring, try one of the https://spring.io/guides[guides]. -* If you are upgrading, check out the https://docs.spring.io/spring-data/keyvalue/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features. +* 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. * Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-keyvalue`]. You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter]. * 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: == Building from Source 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]. -You also need JDK 1.8. +You also need JDK 17. [source,bash] ---- @@ -142,7 +142,7 @@ Building the documentation builds also the project without running tests. $ ./mvnw clean install -Pantora ---- -The generated documentation is available from `target/antora/site/data-keyvalue/index.html`. +The generated documentation is available from `target/antora/site/index.html`. == Examples diff --git a/src/main/antora/antora-playbook.yml b/src/main/antora/antora-playbook.yml index fdde7e1..82d3d16 100644 --- a/src/main/antora/antora-playbook.yml +++ b/src/main/antora/antora-playbook.yml @@ -5,10 +5,10 @@ antora: extensions: - '@antora/collector-extension' - require: '@springio/antora-extensions/root-component-extension' - root_component_name: 'data-redis' + root_component_name: 'data-keyvalue' site: title: Spring Data KeyValue - url: https://docs.spring.io/spring-data-keyvalue/reference/ + url: https://docs.spring.io/spring-data/keyvalue/reference/ content: sources: - url: ./../../.. diff --git a/src/main/antora/modules/ROOT/nav.adoc b/src/main/antora/modules/ROOT/nav.adoc index 3796b4c..3b315c3 100644 --- a/src/main/antora/modules/ROOT/nav.adoc +++ b/src/main/antora/modules/ROOT/nav.adoc @@ -1,6 +1,6 @@ -* xref:index.adoc[] +* xref:index.adoc[Overview] * xref:keyvalue.adoc[] -** xref:keyvalue/template.adoc[] +* xref:keyvalue/template.adoc[] * xref:repositories.adoc[] ** xref:repositories/core-concepts.adoc[] diff --git a/src/main/antora/resources/antora-resources/antora.yml b/src/main/antora/resources/antora-resources/antora.yml index 10b0d39..4c24132 100644 --- a/src/main/antora/resources/antora-resources/antora.yml +++ b/src/main/antora/resources/antora-resources/antora.yml @@ -3,7 +3,7 @@ prerelease: ${antora-component.prerelease} asciidoc: attributes: - copyright-year: 2023 + copyright-year: ${current.year} version: ${project.version} springversionshort: ${spring.short} springversion: ${spring}