root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity
spring-framework/src/docs/asciidoc/index.adoc

27 lines
1.2 KiB
Plaintext
Raw Normal View History

Polish index.html
2017-10-06 03:31:27 +08:00
= Spring Framework Documentation
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
:doc-root: https://docs.spring.io
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
Feature Github Wiki more prominently Issue: SPR-17469
2018-11-06 02:10:58 +08:00
****
General doc revision: configuration updates, consistent formatting etc
2019-03-05 20:08:34 +08:00
_What's New_, _Upgrade Notes_, _Supported Versions_, and other topics,
Consistent spelling on index page
2019-05-07 19:46:27 +08:00
independent of release cadence, are maintained externally on the project's
Polish index.html
2017-10-06 03:31:27 +08:00
https://github.com/spring-projects/spring-framework/wiki[*Github Wiki*].
Feature Github Wiki more prominently Issue: SPR-17469
2018-11-06 02:10:58 +08:00
****
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.
2017-10-04 05:55:14 +08:00
[horizontal]
Consistent spelling on index page
2019-05-07 19:46:27 +08:00
<<overview.adoc#overview, Overview>> :: history, design philosophy, feedback,
Feature Github Wiki more prominently Issue: SPR-17469
2018-11-06 02:10:58 +08:00
getting started.
Consistent spelling on index page
2019-05-07 19:46:27 +08:00
<<core.adoc#spring-core, Core>> :: IoC Container, Events, Resources, i18n,
Validation, Data Binding, Type Conversion, SpEL, AOP.
<<testing.adoc#testing, Testing>> :: Mock Objects, TestContext Framework,
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.
2017-10-04 05:55:14 +08:00
Spring MVC Test, WebTestClient.
Consistent spelling on index page
2019-05-07 19:46:27 +08:00
<<data-access.adoc#spring-data-tier, Data Access>> :: Transactions, DAO Support,
JDBC, O/R Mapping, XML Marshalling.
<<web.adoc#spring-web, Web Servlet>> :: Spring MVC, WebSocket, SockJS,
STOMP Messaging.
<<web-reactive.adoc#spring-webflux, Web Reactive>> :: Spring WebFlux, WebClient,
WebSocket.
<<integration.adoc#spring-integration, Integration>> :: Remoting, JMS, JCA, JMX,
Email, Tasks, Scheduling, Caching.
<<languages.adoc#languages, Languages>> :: Kotlin, Groovy, Dynamic Languages.