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

32 lines
2.5 KiB
Plaintext
Raw Normal View History

Reinstate single page reference documentation This commit reinstates the single-page variant for the Spring Boot reference documentation. Now the single and multi-page variants are hosted under the same `"html"` folder, as `"index.html"` and `"single-index.html"`. Note that files ending in `"index.html`" are treated as index files by the spring-doc-resources project and their table of contents do not display a "Back to index" link. Fixes gh-16295
2019-04-24 04:41:40 +08:00
[[spring-boot-reference-documentation]]
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[]
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
:docinfo: shared
Move Spring Boot version to main index in reference guide Closes gh-24848
2021-01-15 23:50:45 +08:00
include::attributes.adoc[]
*{spring-boot-version}*
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
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]
Polish "Change "Colophon" to "Legal"" Closes gh-15580
2019-02-12 23:48:15 +08:00
<<legal.adoc#legal,Legal>> :: Legal information.
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
<<documentation-overview.adoc#boot-documentation,Documentation Overview>> :: About the Documentation, Getting Help, First Steps, and more.
<<getting-started.adoc#getting-started,Getting Started>> :: Introducing Spring Boot, System Requirements, Servlet Containers, Installing Spring Boot, Developing Your First Spring Boot Application
List DevTools in section overview of multi-page documentation Closes gh-22591
2020-07-28 21:36:23 +08:00
<<using-spring-boot.adoc#using-boot,Using Spring Boot>> :: Build Systems, Structuring Your Code, Configuration, Spring Beans and Dependency Injection, DevTools, and more.
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-features.adoc#boot-features,Spring Boot Features>> :: Profiles, Logging, Security, Caching, Spring Integration, Testing, and more.
<<production-ready-features.adoc#production-ready,Spring Boot Actuator>> :: Monitoring, Metrics, Auditing, and more.
<<deployment.adoc#deployment,Deploying Spring Boot Applications>> :: Deploying to the Cloud, Installing as a Unix application.
<<spring-boot-cli.adoc#cli,Spring Boot CLI>> :: Installing the CLI, Using the CLI, Configuring the CLI, and more.
<<build-tool-plugins.adoc#build-tool-plugins,Build Tool Plugins>> :: Maven Plugin, Gradle Plugin, Antlib, and more.
<<howto.adoc#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]
<<appendix-application-properties.adoc#common-application-properties,Application Properties>> :: Common application properties that can be used to configure your application.
<<appendix-configuration-metadata.adoc#configuration-metadata,Configuration Metadata>> :: Metadata used to describe configuration properties.
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes,Auto-configuration Classes>> :: Auto-configuration classes provided by Spring Boot.
<<appendix-test-auto-configuration.adoc#test-auto-configuration,Test Auto-configuration Annotations>> :: Test-autoconfiguration annotations used to test slices of your application.
<<appendix-executable-jar-format.adoc#executable-jar,Executable Jars>> :: Spring Boot's executable jars, their launchers, and their format.
Fix broken documentation links See gh-19936
2020-01-27 02:22:12 +08:00
<<appendix-dependency-versions.adoc#dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.