From d8f160c178d86d2421ba3f8bfba8ea183af436cb Mon Sep 17 00:00:00 2001 From: Eleftheria Stein Date: Mon, 2 Mar 2020 15:25:58 -0500 Subject: [PATCH] Update documentation styling Upgrade spring-build-conventions to 0.0.28.RELEASE Resolves: #1585 --- build.gradle | 2 +- spring-session-docs/spring-session-docs.gradle | 4 +++- .../src/docs/asciidoc/guides/boot-findbyusername.adoc | 7 ++++++- .../src/docs/asciidoc/guides/boot-jdbc.adoc | 8 +++++++- .../src/docs/asciidoc/guides/boot-redis.adoc | 8 +++++++- .../src/docs/asciidoc/guides/boot-websocket.adoc | 8 +++++++- .../src/docs/asciidoc/guides/docinfo-footer.html | 2 ++ .../src/docs/asciidoc/guides/java-custom-cookie.adoc | 8 +++++++- .../src/docs/asciidoc/guides/java-hazelcast.adoc | 8 +++++++- .../src/docs/asciidoc/guides/java-jdbc.adoc | 8 +++++++- .../src/docs/asciidoc/guides/java-redis.adoc | 8 +++++++- .../src/docs/asciidoc/guides/java-rest.adoc | 8 +++++++- .../src/docs/asciidoc/guides/java-security.adoc | 8 +++++++- .../src/docs/asciidoc/guides/xml-jdbc.adoc | 8 +++++++- .../src/docs/asciidoc/guides/xml-redis.adoc | 8 +++++++- 15 files changed, 89 insertions(+), 14 deletions(-) create mode 100644 spring-session-docs/src/docs/asciidoc/guides/docinfo-footer.html diff --git a/build.gradle b/build.gradle index 38525fd1..296372cb 100644 --- a/build.gradle +++ b/build.gradle @@ -13,7 +13,7 @@ buildscript { } dependencies { - classpath 'io.spring.gradle:spring-build-conventions:0.0.27.RELEASE' + classpath 'io.spring.gradle:spring-build-conventions:0.0.28.RELEASE' classpath "org.springframework.boot:spring-boot-gradle-plugin:$springBootVersion" } } diff --git a/spring-session-docs/spring-session-docs.gradle b/spring-session-docs/spring-session-docs.gradle index fb412607..75f07890 100644 --- a/spring-session-docs/spring-session-docs.gradle +++ b/spring-session-docs/spring-session-docs.gradle @@ -46,5 +46,7 @@ asciidoctor { 'spring-session-version': project.version, 'version-milestone': milestoneBuild, 'version-release': releaseBuild, - 'version-snapshot': snapshotBuild + 'version-snapshot': snapshotBuild, + 'highlightjsdir@': "js/highlight", + 'docinfodir@': "." } diff --git a/spring-session-docs/src/docs/asciidoc/guides/boot-findbyusername.adoc b/spring-session-docs/src/docs/asciidoc/guides/boot-findbyusername.adoc index f141d3d7..e9907e14 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/boot-findbyusername.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/boot-findbyusername.adoc @@ -1,11 +1,16 @@ = Spring Session - find by username Rob Winch -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to find sessions by username. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] [[findbyusername-assumptions]] == Assumptions diff --git a/spring-session-docs/src/docs/asciidoc/guides/boot-jdbc.adoc b/spring-session-docs/src/docs/asciidoc/guides/boot-jdbc.adoc index fd66bf68..8a086c52 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/boot-jdbc.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/boot-jdbc.adoc @@ -1,11 +1,17 @@ = Spring Session - Spring Boot Rob Winch, Vedran Pavić -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to transparently leverage a relational database to back a web application's `HttpSession` when you use Spring Boot. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. diff --git a/spring-session-docs/src/docs/asciidoc/guides/boot-redis.adoc b/spring-session-docs/src/docs/asciidoc/guides/boot-redis.adoc index 4dc85e0d..7185268b 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/boot-redis.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/boot-redis.adoc @@ -1,11 +1,17 @@ = Spring Session - Spring Boot Rob Winch, Vedran Pavić -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to transparently leverage Redis to back a web application's `HttpSession` when you use Spring Boot. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must ensure your dependencies. diff --git a/spring-session-docs/src/docs/asciidoc/guides/boot-websocket.adoc b/spring-session-docs/src/docs/asciidoc/guides/boot-websocket.adoc index 5c88ea5f..985f3156 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/boot-websocket.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/boot-websocket.adoc @@ -1,7 +1,10 @@ = Spring Session - WebSocket Rob Winch -:toc: +:toc: left :websocketdoc-test-dir: {docs-test-dir}docs/websocket/ +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to ensure that WebSocket messages keep your HttpSession alive. @@ -12,6 +15,9 @@ Specifically,it does not work with using https://www.jcp.org/en/jsr/detail?id=35 // end::disclaimer[] +[#index-link] +link:../index.html[Index] + == HttpSession Setup The first step is to integrate Spring Session with the HttpSession. These steps are already outlined in the link:httpsession.html[HttpSession Guide]. diff --git a/spring-session-docs/src/docs/asciidoc/guides/docinfo-footer.html b/spring-session-docs/src/docs/asciidoc/guides/docinfo-footer.html new file mode 100644 index 00000000..6f86938b --- /dev/null +++ b/spring-session-docs/src/docs/asciidoc/guides/docinfo-footer.html @@ -0,0 +1,2 @@ + + diff --git a/spring-session-docs/src/docs/asciidoc/guides/java-custom-cookie.adoc b/spring-session-docs/src/docs/asciidoc/guides/java-custom-cookie.adoc index 8f5e1032..d19f43a6 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/java-custom-cookie.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/java-custom-cookie.adoc @@ -1,12 +1,18 @@ = Spring Session - Custom Cookie Rob Winch; Eleftheria Stein-Kousathana -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to configure Spring Session to use custom cookies with Java Configuration. The guide assumes you have already link:./httpsession.html[set up Spring Session in your project]. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + [[custom-cookie-spring-configuration]] == Spring Java Configuration diff --git a/spring-session-docs/src/docs/asciidoc/guides/java-hazelcast.adoc b/spring-session-docs/src/docs/asciidoc/guides/java-hazelcast.adoc index 88df6ad6..03727f49 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/java-hazelcast.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/java-hazelcast.adoc @@ -1,12 +1,18 @@ = Spring Session and Spring Security with Hazelcast Tommy Ludwig; Rob Winch -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session along with Spring Security when you use Hazelcast as your data store. It assumes that you have already applied Spring Security to your application. NOTE: You cand find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. diff --git a/spring-session-docs/src/docs/asciidoc/guides/java-jdbc.adoc b/spring-session-docs/src/docs/asciidoc/guides/java-jdbc.adoc index 133e8ff9..bc27fe52 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/java-jdbc.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/java-jdbc.adoc @@ -1,11 +1,17 @@ = Spring Session - HttpSession (Quick Start) Rob Winch, Vedran Pavić -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to transparently leverage a relational database to back a web application's `HttpSession` with Java Configuration. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. diff --git a/spring-session-docs/src/docs/asciidoc/guides/java-redis.adoc b/spring-session-docs/src/docs/asciidoc/guides/java-redis.adoc index 8e15d93c..7777e194 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/java-redis.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/java-redis.adoc @@ -1,12 +1,18 @@ = Spring Session - HttpSession (Quick Start) Rob Winch -:toc: +:toc: left :version-snapshot: true +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to transparently leverage Redis to back a web application's `HttpSession` with Java Configuration. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. If you are using Maven, you must add the following dependencies: diff --git a/spring-session-docs/src/docs/asciidoc/guides/java-rest.adoc b/spring-session-docs/src/docs/asciidoc/guides/java-rest.adoc index 299e1c29..dfcd430e 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/java-rest.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/java-rest.adoc @@ -1,11 +1,17 @@ = Spring Session - REST Rob Winch -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to transparently leverage Redis to back a web application's `HttpSession` when you use REST endpoints. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. diff --git a/spring-session-docs/src/docs/asciidoc/guides/java-security.adoc b/spring-session-docs/src/docs/asciidoc/guides/java-security.adoc index af9a9ac0..65c5f5cc 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/java-security.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/java-security.adoc @@ -1,12 +1,18 @@ = Spring Session and Spring Security Rob Winch -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session along with Spring Security. It assumes you have already applied Spring Security to your application. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. If you use Maven, you must add the following dependencies: diff --git a/spring-session-docs/src/docs/asciidoc/guides/xml-jdbc.adoc b/spring-session-docs/src/docs/asciidoc/guides/xml-jdbc.adoc index 52ea9ee4..7cc461f7 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/xml-jdbc.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/xml-jdbc.adoc @@ -1,11 +1,17 @@ = Spring Session - HttpSession (Quick Start) Rob Winch, Vedran Pavić -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to transparently leverage a relational to back a web application's `HttpSession` with XML based configuration. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. diff --git a/spring-session-docs/src/docs/asciidoc/guides/xml-redis.adoc b/spring-session-docs/src/docs/asciidoc/guides/xml-redis.adoc index 02c34f47..4a5a2db5 100644 --- a/spring-session-docs/src/docs/asciidoc/guides/xml-redis.adoc +++ b/spring-session-docs/src/docs/asciidoc/guides/xml-redis.adoc @@ -1,11 +1,17 @@ = Spring Session - HttpSession (Quick Start) Rob Winch -:toc: +:toc: left +:stylesdir: ../ +:highlightjsdir: ../js/highlight +:docinfodir: guides This guide describes how to use Spring Session to transparently leverage Redis to back a web application's `HttpSession` with XML-based configuration. NOTE: You can find the completed guide in the <>. +[#index-link] +link:../index.html[Index] + == Updating Dependencies Before you use Spring Session, you must update your dependencies. If you use Maven, you must add the following dependencies: