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

40 lines
3.1 KiB
Plaintext
Raw Normal View History

Rationalize reference documentation anchors Closes gh-26296
2021-04-29 12:51:19 +08:00
[[index]]
Reorganize asciidoc content This commit adds an index page for the multi-file HTML version, and fixed a couple of casing issues (significant words starting with lower case in headings). While researching how to get the content from index-docinfo.xml into the output, I came across the notion of a colophon, which is a good name for the information in that file. I have consequently changed "Legal" (which I never liked but couldn't think of a better term for at the time) to "Colophon". See gh-12611
2018-11-24 04:20:24 +08:00
= Spring Boot Reference Documentation
Define the reference doc authors in a single place Closes gh-20896
2020-07-27 22:20:59 +08:00
include::authors.adoc[]
Use Asciidoctor's revision line to provide document's version Using the revision line means that the revision number is automatically set. The revision number is then included by the HTML and PDF backends in the standard location. In the HTML backend that's alongside the list of authors. In the PDF backend that's on the title page. Closes gh-26851
2021-06-14 20:24:01 +08:00
v{spring-boot-version}
Move Spring Boot version to main index in reference guide Closes gh-24848
2021-01-15 23:50:45 +08:00
include::attributes.adoc[]
Reorder documentation overview section The documentation overview sections is supposed to provide a map for the rest of the reference document. The getting help and upgrading sections were moved to align with that.
2021-06-10 12:36:28 +08:00
This document is also available as {spring-boot-docs}/html/[Multi-page HTML], {spring-boot-docs}/htmlsingle/[Single page HTML] and {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF].
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Reorganize asciidoc content This commit adds an index page for the multi-file HTML version, and fixed a couple of casing issues (significant words starting with lower case in headings). While researching how to get the content from index-docinfo.xml into the output, I came across the notion of a colophon, which is a good name for the information in that file. I have consequently changed "Legal" (which I never liked but couldn't think of a better term for at the time) to "Colophon". See gh-12611
2018-11-24 04:20:24 +08:00
The reference documentation consists of the following sections:
Add documentation tool-chain Generate html, pdf and epub documentation using asciidoctor+docbook. See gh-295
2014-03-14 04:15:33 +08:00
Reorganize asciidoc content This commit adds an index page for the multi-file HTML version, and fixed a couple of casing issues (significant words starting with lower case in headings). While researching how to get the content from index-docinfo.xml into the output, I came across the notion of a colophon, which is a good name for the information in that file. I have consequently changed "Legal" (which I never liked but couldn't think of a better term for at the time) to "Colophon". See gh-12611
2018-11-24 04:20:24 +08:00
[horizontal]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
<<legal#legal,Legal>> :: Legal information.
Reorder documentation overview section The documentation overview sections is supposed to provide a map for the rest of the reference document. The getting help and upgrading sections were moved to align with that.
2021-06-10 12:36:28 +08:00
<<getting-help#getting-help,Getting Help>> :: Resources for getting help.
<<documentation#documentation,Documentation Overview>> :: About the Documentation, First Steps, and more.
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
<<getting-started#getting-started,Getting Started>> :: Introducing Spring Boot, System Requirements, Servlet Containers, Installing Spring Boot, Developing Your First Spring Boot Application
Reorder documentation overview section The documentation overview sections is supposed to provide a map for the rest of the reference document. The getting help and upgrading sections were moved to align with that.
2021-06-10 12:36:28 +08:00
<<upgrading#upgrading,Upgrading Spring Boot Applications>> :: Upgrading from 1.x, Upgrading to a new feature release, Upgrading the Spring Boot CLI
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
<<using#using,Using Spring Boot>> :: Build Systems, Structuring Your Code, Configuration, Spring Beans and Dependency Injection, DevTools, and more.
Split spring boot features into multiple sections See gh-27132
2021-06-23 09:06:49 +08:00
<<features#features,Core Features>> :: Profiles, Logging, Security, Caching, Spring Integration, Testing, and more.
<<web#web,Web>> :: Servlet Web, Reactive Web, Embedded Container Support, Graceful Shutdown and more.
<<data#data,Data>> :: SQL and NOSQL data access.
<<io#io,IO>> :: Caching, Quartz Scheduler, REST clients, Sending email, Spring Web Services and more.
<<messaging#messaging,Messaging>> :: JMS, AMQP, RSocket, WebSocket, Spring Integration.
<<container-images#container-images,Container Images>> :: Efficient container images, Building container images with Dockerfiles and Cloud Native Buildpacks.
<<actuator#actuator,Production-ready Features>> :: Monitoring, Metrics, Auditing, and more.
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
<<deployment#deployment,Deploying Spring Boot Applications>> :: Deploying to the Cloud, Installing as a Unix application.
<<cli#cli,Spring Boot CLI>> :: Installing the CLI, Using the CLI, Configuring the CLI, and more.
<<build-tool-plugins#build-tool-plugins,Build Tool Plugins>> :: Maven Plugin, Gradle Plugin, Antlib, and more.
<<howto#howto,"`How-to`" Guides>> :: Application Development, Configuration, Embedded Servers, Data Access, and many more.
Split appendices into multiple pages and include a ToC in each Closes gh-16289
2019-09-17 16:44:40 +08:00
The reference documentation has the following appendices:
[horizontal]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
<<application-properties#application-properties,Application Properties>> :: Common application properties that can be used to configure your application.
<<configuration-metadata#configuration-metadata,Configuration Metadata>> :: Metadata used to describe configuration properties.
<<auto-configuration-classes#auto-configuration-classes,Auto-configuration Classes>> :: Auto-configuration classes provided by Spring Boot.
<<test-auto-configuration#test-auto-configuration,Test Auto-configuration Annotations>> :: Test auto-configuration annotations used to test slices of your application.
<<executable-jar#executable-jar,Executable Jars>> :: Spring Boot's executable jars, their launchers, and their format.
<<dependency-versions#dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.