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

65 lines
1.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]]
= 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}
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
include::attributes.adoc[]
Polish "Only link to other formats from each format of the ref docs" See gh-27737
2021-08-24 00:34:11 +08:00
ifdef::backend-spring-html[]
This document is also available as {spring-boot-docs}/html/[multiple HTML pages] and as {spring-boot-docs}/pdf/spring-boot-reference.pdf[a PDF].
Only link to other formats from each format of the ref docs See gh-27737
2021-08-18 00:09:40 +08:00
endif::[]
Polish "Only link to other formats from each format of the ref docs" See gh-27737
2021-08-24 00:34:11 +08:00
ifdef::backend-spring-pdf[]
Only link to other formats from each format of the ref docs See gh-27737
2021-08-18 00:09:40 +08:00
This document is also available as {spring-boot-docs}/html/[multiple HTML pages] and as {spring-boot-docs}/htmlsingle/[a single HTML page].
endif::[]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
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
include::legal.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
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
include::getting-help.adoc[leveloffset=+1]
Align adoc filename with anchors See gh-26296
2021-04-29 13:34:16 +08:00
include::documentation.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
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
include::getting-started.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
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
include::upgrading.adoc[leveloffset=+1]
Align adoc filename with anchors See gh-26296
2021-04-29 13:34:16 +08:00
include::using.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Align adoc filename with anchors See gh-26296
2021-04-29 13:34:16 +08:00
include::features.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Split spring boot features into multiple sections See gh-27132
2021-06-23 09:06:49 +08:00
include::web.adoc[leveloffset=+1]
include::data.adoc[leveloffset=+1]
include::messaging.adoc[leveloffset=+1]
include::io.adoc[leveloffset=+1]
include::container-images.adoc[leveloffset=+1]
Align adoc filename with anchors See gh-26296
2021-04-29 13:34:16 +08:00
include::actuator.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
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
include::deployment.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Align adoc filename with anchors See gh-26296
2021-04-29 13:34:16 +08:00
include::cli.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
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
include::build-tool-plugins.adoc[leveloffset=+1]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
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
include::howto.adoc[leveloffset=+1]
Split appendices into multiple pages and include a ToC in each Closes gh-16289
2019-09-17 16:44:40 +08:00
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
:sectnums!:
Split appendices into multiple pages and include a ToC in each Closes gh-16289
2019-09-17 16:44:40 +08:00
[[appendix]]
== Appendices
Move appendix subsections under appendix section This involved a small code change to the generated configuration properties snippets. The section id has to start with 'appendix.', otherwise the section-id asciidoctor extension complains. To ensure that the anchors that are derived from the section IDs remain backwards compatible, the anchor-rewrite properties have been updated. See gh-29667
2022-02-07 18:09:53 +08:00
include::application-properties.adoc[leveloffset=+2]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Move appendix subsections under appendix section This involved a small code change to the generated configuration properties snippets. The section id has to start with 'appendix.', otherwise the section-id asciidoctor extension complains. To ensure that the anchors that are derived from the section IDs remain backwards compatible, the anchor-rewrite properties have been updated. See gh-29667
2022-02-07 18:09:53 +08:00
include::configuration-metadata.adoc[leveloffset=+2]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Move appendix subsections under appendix section This involved a small code change to the generated configuration properties snippets. The section id has to start with 'appendix.', otherwise the section-id asciidoctor extension complains. To ensure that the anchors that are derived from the section IDs remain backwards compatible, the anchor-rewrite properties have been updated. See gh-29667
2022-02-07 18:09:53 +08:00
include::auto-configuration-classes.adoc[leveloffset=+2]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Move appendix subsections under appendix section This involved a small code change to the generated configuration properties snippets. The section id has to start with 'appendix.', otherwise the section-id asciidoctor extension complains. To ensure that the anchors that are derived from the section IDs remain backwards compatible, the anchor-rewrite properties have been updated. See gh-29667
2022-02-07 18:09:53 +08:00
include::test-auto-configuration.adoc[leveloffset=+2]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Move appendix subsections under appendix section This involved a small code change to the generated configuration properties snippets. The section id has to start with 'appendix.', otherwise the section-id asciidoctor extension complains. To ensure that the anchors that are derived from the section IDs remain backwards compatible, the anchor-rewrite properties have been updated. See gh-29667
2022-02-07 18:09:53 +08:00
include::executable-jar.adoc[leveloffset=+2]
Split up adoc files Closes gh-23254
2021-04-30 00:11:56 +08:00
Move appendix subsections under appendix section This involved a small code change to the generated configuration properties snippets. The section id has to start with 'appendix.', otherwise the section-id asciidoctor extension complains. To ensure that the anchors that are derived from the section IDs remain backwards compatible, the anchor-rewrite properties have been updated. See gh-29667
2022-02-07 18:09:53 +08:00
include::dependency-versions.adoc[leveloffset=+2]