Skip to content

Commit 45c207a

Browse files
committed
What's new and migrating are prominently featured
Before this commit those were burried in the Appendix where few would guess to look. Previously that information was at the top, so it makes sense to point to the Github wiki from the index HTML page. Also a general update of the index page. Since we have recently revised the overview, we can simply point to it and keep it shorter. The section listing now includes more details per section.
1 parent 6597551 commit 45c207a

File tree

3 files changed

+30
-45
lines changed

3 files changed

+30
-45
lines changed

src/docs/asciidoc/appendix.adoc

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,6 @@
77
:toclevels: 2
88
:docinfo1:
99

10-
[[spring-whats-new]]
11-
== What's New in the Spring Framework
12-
"What's New" guides for releases of the Spring Framework are now provided as a
13-
link:{wiki-spring-framework}/++What's-New-in-the-Spring-Framework++[Wiki page].
14-
15-
16-
[[migration-4.x]]
17-
== Migrating to Spring Framework 4.3 / 5.0
18-
Migration guides for upgrading from previous releases of the Spring Framework are now provided as a
19-
{wiki-spring-framework}/Migrating-from-earlier-versions-of-the-spring-framework[Wiki page].
20-
21-
2210
[[annotation-programming-model]]
2311
== Spring Annotation Programming Model
2412
Spring's annotation programming model is documented in the

src/docs/asciidoc/index.adoc

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,27 @@ The Spring Framework team and contributors https://github.com/spring-projects/sp
33
:doc-root: https://docs.spring.io
44
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
55

6-
7-
The Spring Framework is a lightweight solution and a potential one-stop-shop for
8-
building your enterprise-ready applications. However, Spring is modular, allowing you to
9-
use only those parts that you need, without having to bring in the rest. You can use the
10-
IoC container, with any web framework on top, but you can also use only the
11-
<<data-access.adoc#orm-hibernate,Hibernate integration code>> or the
12-
<<data-access.adoc#jdbc-introduction,JDBC abstraction layer>>. The Spring Framework supports declarative
13-
transaction management, remote access to your logic through RMI or web services, and various
14-
options for persisting your data.
15-
It offers full-featured web frameworks such as <<web.adoc#mvc,Spring Web MVC>>
16-
and <<web-reactive.adoc#webflux, Spring WebFlux>>; and it enables you to
17-
integrate <<core.adoc#aop-introduction,AOP>> transparently into your software.
18-
19-
This document is a reference guide to Spring Framework features. Questions on the
20-
Framework itself should be asked on StackOverflow (see https://spring.io/questions[]).
21-
22-
This reference document provides the following sections:
23-
24-
* <<overview.adoc#spring-introduction,Overview of the Spring Framework>>
25-
26-
* <<core.adoc#spring-core,Core concepts such as IoC and AOP>>
27-
28-
* <<testing.adoc#testing,Testing with Spring>>
29-
30-
* <<data-access.adoc#spring-data-tier,Data access and transaction management>>
31-
32-
* The Web on <<web.adoc#spring-web,Servlet>> or <<web-reactive.adoc#spring-webflux,Reactive>> stacks
33-
34-
* <<kotlin.adoc#kotlin,Kotlin support>>
35-
36-
* <<integration.adoc#spring-integration,Integration with other technologies>>
37-
38-
* <<appendix.adoc#spring-appendices,Appendix>>
6+
Welcome to the Spring Framework reference!
7+
8+
Please read the <<overview.adoc,Overview>> for an introduction including brief history,
9+
design philosophy, where to ask questions, and tips to get started. For information on
10+
what's new, or migrating from a previous version, check the
11+
https://github.com/spring-projects/spring-framework/wiki[Github Wiki].
12+
13+
The reference is divided into several sections:
14+
15+
[horizontal]
16+
<<core.adoc#spring-core,Core>> :: IoC container, Events, Resources, i18n, Validation,
17+
Data Binding, Type Conversion, SpEL, AOP.
18+
<<testing.adoc#testing,Testing>> :: Mock objects, TestContext framework,
19+
Spring MVC Test, WebTestClient.
20+
<<data-access.adoc#spring-data-tier,Data Access>> :: Transactions, DAO support, JDBC,
21+
ORM, Marshalling XML.
22+
<<web.adoc#spring-web,Web Servlet>> :: Spring MVC web framework, WebSocket,
23+
SockJS, STOMP messaging.
24+
<<web-reactive.adoc#spring-webflux,Web Reactive>> :: Spring WebFlux,
25+
WebClient, WebSocket support.
26+
<<integration.adoc#spring-integration,Integration>> :: Remoting, JMS, JCA, JMX, Email,
27+
Tasks, Scheduling, Cache, Dynamic languages.
28+
<<kotlin.adoc#kotlin,Kotlin>> :: Extensions, Bean Definition DSL, WebFlux DSL
29+
<<appendix.adoc#spring-appendices,Appendix>> :: XML Schemas, JSP Tag Libraries

src/docs/asciidoc/overview.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
:toc: left
22
:toclevels: 1
33
:docinfo1:
4+
45
= Spring Framework Overview
56

67
Spring makes it easy to create Java enterprise applications. It provides everything you
@@ -19,6 +20,7 @@ Spring is open source. It has a large and active community that provides continu
1920
based on a diverse range of real-world use cases. This has helped Spring to successfully
2021
evolve over a very long time.
2122

23+
[[overview-spring]]
2224
== What We Mean by "Spring"
2325

2426
The term "Spring" means different things in different contexts. It can be used to refer to
@@ -41,6 +43,7 @@ A note about modules: Spring's framework jars allow for deployment to JDK 9's mo
4143
the same naming pattern with "-" instead of ".", e.g. "spring-core" and "spring-context").
4244
Of course, Spring's framework jars keep working fine on the classpath on both JDK 8 and 9.
4345

46+
[[overview-history]]
4447
== History of Spring and the Spring Framework
4548

4649
Spring came into being in 2003 as a response to the complexity of the early
@@ -81,6 +84,7 @@ among others. It’s important to remember that each project has its own source
8184
issue tracker, and release cadence. See https://spring.io/projects[spring.io/projects] for
8285
the complete list of Spring projects.
8386

87+
[[overview-philosophy]]
8488
== Design Philosophy
8589

8690
When you learn about a framework, it’s important to know not only what it does but what
@@ -103,6 +107,7 @@ that are intuitive and that hold up across many versions and many years.
103107
meaningful, current, and accurate Javadoc. It is one of very few projects that can claim
104108
clean code structure with no circular dependencies between packages.
105109

110+
[[overview-feedback]]
106111
== Feedback and Contributions
107112

108113
For how-to questions or diagnosing or debugging issues, we suggest using StackOverflow,
@@ -122,6 +127,7 @@ information that is not specific to any one version. For example, it has migrati
122127
notes from earlier versions, comprehensive information on what's new across multiple
123128
versions, contributor guidelines, the Spring Framework code style, and other information.
124129

130+
[[overview-getting-started]]
125131
== Getting Started
126132

127133
If you are just getting started with Spring, you may want to begin using the Spring

0 commit comments

Comments
 (0)