From 825449a3d2aa2b70ed7967ee2c266da5e26aaf9e Mon Sep 17 00:00:00 2001 From: Sebastien Deleuze Date: Mon, 18 Sep 2017 12:16:47 +0200 Subject: [PATCH] Introduce a link to go back to refdoc index --- src/docs/asciidoc/appendix.adoc | 1 + src/docs/asciidoc/core.adoc | 1 + src/docs/asciidoc/data-access.adoc | 1 + src/docs/asciidoc/docinfo-footer.html | 10 ++++++++++ src/docs/asciidoc/integration.adoc | 1 + src/docs/asciidoc/kotlin.adoc | 1 + src/docs/asciidoc/overview.adoc | 15 +++++++++------ src/docs/asciidoc/reactive-web.adoc | 1 + src/docs/asciidoc/testing.adoc | 1 + src/docs/asciidoc/web.adoc | 1 + 10 files changed, 27 insertions(+), 6 deletions(-) create mode 100644 src/docs/asciidoc/docinfo-footer.html diff --git a/src/docs/asciidoc/appendix.adoc b/src/docs/asciidoc/appendix.adoc index 4d661e561d..a1a8a3080d 100644 --- a/src/docs/asciidoc/appendix.adoc +++ b/src/docs/asciidoc/appendix.adoc @@ -5,6 +5,7 @@ :wiki-spring-framework: https://github.com/spring-projects/spring-framework/wiki :toc: left :toclevels: 2 +:docinfo1: [[spring-whats-new]] == What's New in the Spring Framework diff --git a/src/docs/asciidoc/core.adoc b/src/docs/asciidoc/core.adoc index 212ee519b9..2c40f336da 100644 --- a/src/docs/asciidoc/core.adoc +++ b/src/docs/asciidoc/core.adoc @@ -4,6 +4,7 @@ :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework :toc: left :toclevels: 2 +:docinfo1: This part of the reference documentation covers all of those technologies that are absolutely integral to the Spring Framework. diff --git a/src/docs/asciidoc/data-access.adoc b/src/docs/asciidoc/data-access.adoc index e754cc6a43..924016e685 100644 --- a/src/docs/asciidoc/data-access.adoc +++ b/src/docs/asciidoc/data-access.adoc @@ -4,6 +4,7 @@ :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework :toc: left :toclevels: 2 +:docinfo1: This part of the reference documentation is concerned with data access and the interaction between the data access layer and the business or service layer. diff --git a/src/docs/asciidoc/docinfo-footer.html b/src/docs/asciidoc/docinfo-footer.html new file mode 100644 index 0000000000..d819137f44 --- /dev/null +++ b/src/docs/asciidoc/docinfo-footer.html @@ -0,0 +1,10 @@ + \ No newline at end of file diff --git a/src/docs/asciidoc/integration.adoc b/src/docs/asciidoc/integration.adoc index e8f8f47349..87d12e10da 100644 --- a/src/docs/asciidoc/integration.adoc +++ b/src/docs/asciidoc/integration.adoc @@ -6,6 +6,7 @@ :doc-spring-gemfire: {doc-root}/spring-gemfire/docs/current/reference :toc: left :toclevels: 2 +:docinfo1: This part of the reference documentation covers the Spring Framework's integration with a number of Java EE (and related) technologies. diff --git a/src/docs/asciidoc/kotlin.adoc b/src/docs/asciidoc/kotlin.adoc index 5aaf2b5814..e46d582686 100644 --- a/src/docs/asciidoc/kotlin.adoc +++ b/src/docs/asciidoc/kotlin.adoc @@ -4,6 +4,7 @@ :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework :toc: left :toclevels: 2 +:docinfo1: [[introduction]] == Introduction diff --git a/src/docs/asciidoc/overview.adoc b/src/docs/asciidoc/overview.adoc index aa2a02643d..7efc049a1a 100644 --- a/src/docs/asciidoc/overview.adoc +++ b/src/docs/asciidoc/overview.adoc @@ -1,4 +1,7 @@ -== Spring Framework Overview +:toc: left +:toclevels: 1 +:docinfo1: += Spring Framework Overview Spring makes it easy to create Java enterprise applications. It provides everything you need beyond the Java language itself. It also provides extensions and support for @@ -14,7 +17,7 @@ Spring is open source. It has a large and active community that provides continu based on a diverse range of real-world use cases. This has helped Spring to successfully evolve over a very long time. -=== What We Mean by "Spring" +== What We Mean by "Spring" The term, "Spring," means different things in different contexts. It can be used to refer to the Spring Framework project itself, which is where it all started. Over time, other Spring @@ -29,7 +32,7 @@ support for different application architectures, including messaging, transactio persistence, and web. It also includes the servlet-based Spring MVC web framework and, in parallel, the Spring WebFlux reactive web framework. -=== History of Spring and the Spring Framework +== History of Spring and the Spring Framework Spring came into being in 2003 as a response to the complexity of the early https://en.wikipedia.org/wiki/Java_Platform,_Enterprise_Edition[J2EE] specifications. @@ -62,7 +65,7 @@ among others. It’s important to remember that each project has its own source issue tracker, and release cadence. See https://spring.io/projects[spring.io/projects] for the complete list of Spring projects. -=== Design Philosophy +== Design Philosophy When you learn about a framework, it’s important to know not only what it does but what principles it follows. Here are the guiding principles of the Spring Framework: @@ -84,7 +87,7 @@ that are intuitive and that hold up across many versions and many years. meaningful, current, and accurate Javadoc. It is one of very few projects that can claim clean code structure with no circular dependencies between packages. -=== Feedback and Contributions +== Feedback and Contributions For how-to questions or diagnosing or debugging issues, we suggest using StackOverflow, and we have a https://spring.io/questions[questions page] that lists the suggested tags to use. @@ -103,7 +106,7 @@ information that is not specific to any one version. For example, it has migrati notes from earlier versions, comprehensive information on what's new across multiple versions, contributor guidelines, the Spring Framework code style, and other information. -=== Getting Started +== Getting Started If you are just getting started with Spring, you may want to begin using the Spring Framework by creating a http://projects.spring.io/spring-boot/[Spring Boot]-based diff --git a/src/docs/asciidoc/reactive-web.adoc b/src/docs/asciidoc/reactive-web.adoc index 6324d48a91..59f078e9ea 100644 --- a/src/docs/asciidoc/reactive-web.adoc +++ b/src/docs/asciidoc/reactive-web.adoc @@ -4,6 +4,7 @@ :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework :toc: left :toclevels: 3 +:docinfo1: This part of the documentation covers support for reactive stack, web applications built on http://www.reactive-streams.org/[Reactive Streams] and adapted to non-blocking runtimes diff --git a/src/docs/asciidoc/testing.adoc b/src/docs/asciidoc/testing.adoc index c7ab225ce4..f64d3b0b6a 100644 --- a/src/docs/asciidoc/testing.adoc +++ b/src/docs/asciidoc/testing.adoc @@ -5,6 +5,7 @@ :doc-spring-boot: {doc-root}/spring-boot/docs/current/reference :toc: left :toclevels: 2 +:docinfo1: The adoption of the test-driven-development (TDD) approach to software development is certainly advocated by the Spring team, and so coverage of Spring's diff --git a/src/docs/asciidoc/web.adoc b/src/docs/asciidoc/web.adoc index acb151c348..3baf3a6834 100644 --- a/src/docs/asciidoc/web.adoc +++ b/src/docs/asciidoc/web.adoc @@ -4,6 +4,7 @@ :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework :toc: left :toclevels: 2 +:docinfo1: This part of the documentation covers support for Servlet stack, web applications built on the Servlet API and deployed to Servlet containers. Individual chapters include <>,