Commit Graph

27 Commits

Author SHA1 Message Date
Johnny Lim
332ad7bb70 Polish
See gh-44323

Signed-off-by: Johnny Lim <izeye@naver.com>
2025-02-24 07:46:25 +01:00
Moritz Halbritter
baf596d10e Document double observations when using @Timed etc.
Closes gh-44037
2025-02-06 12:21:31 +01:00
Phillip Webb
3dcea98f00 Polish redirect.adoc by sorting contents alphabetically 2024-12-03 20:30:09 -08:00
Phillip Webb
709cd91b3e Add legacy anchor redirects
Add anchor redirects previously covered by the
`anchor-rewrite.properties` file.

See gh-43367
2024-12-03 20:17:14 -08:00
Phillip Webb
75a3722ee4 Add more anchor redirects
See gh-43367
2024-12-03 20:16:51 -08:00
Phillip Webb
4c8dafe12b Migrate class references to full javadoc links
Update documentation to use `javadoc:...` macro for class and interface
references.

Migrated using https://github.com/philwebb/asciidoctor-javadoc-migration

See gh-41614
2024-11-20 20:24:54 -08:00
Moritz Halbritter
ec236be2bb Merge branch '3.2.x' into 3.3.x
Closes gh-43159
2024-11-14 14:47:52 +01:00
Andy Wilkinson
2bf3e5ab20 Document that embedded Tomcat must be 10.1.25 or later
Closes gh-42849
2024-10-24 09:28:18 +01:00
Moritz Halbritter
89bf2fc7e6 Move "Customize the whitelabel Error Page" into Spring MVC howto
Closes gh-41624
2024-10-14 12:08:31 +02:00
Andy Wilkinson
d4f7cb7bae Merge branch '3.2.x' into 3.3.x
Closes gh-42380
2024-09-19 19:02:03 +01:00
Andy Wilkinson
ea246d378e Merge branch '3.2.x' into 3.3.x
Closes gh-42103
2024-09-03 15:04:22 +01:00
Scott Frederick
03a7f48ac0 Polish documentation for xref hyperlink formatting consistency
This commit improves the consistency of xref link formatting (no
quotes, italics, or other decoration) and uses automatic link
text generation wherever possible.
2024-06-28 17:20:53 -05:00
Scott Frederick
24a8bbd82f Polish use of the term starter in documentation
Use of the term "starter" was sometimes quoted but sometimes was not,
sometimes used proper case and sometimes lowercase. This commit
improves consistency by removing quotes and using lowercase.
2024-06-28 17:19:30 -05:00
Scott Frederick
2df0c7961a Reorganize packaging and optimizing documentation
Documentation for native executables, CDS, and checkpoint/restore are
now under a common heading in the reference documentation, along with
sections on building container images. A few sections containing
prescriptive workflows have been moved from reference to how-to guides.
This consolidates and improves the consistency of recommendations on
how to package and run applications.

Closes gh-40977
2024-06-06 16:11:10 -05:00
Phillip Webb
b082e5d82d Add external link indicators to API docs in Antora
Closes gh-40817
2024-05-17 09:52:24 -07:00
Phillip Webb
9852a66a37 Polish Antora 2024-05-08 15:58:17 -07:00
Phillip Webb
e954afdc2e Tweak documentation redirect 2024-05-06 13:14:48 -07:00
Andy Wilkinson
515bccac6b Polish 2024-04-25 14:10:02 +01:00
Moritz Halbritter
ca6a321b87 Pull the whole "Testing" documentation section up to the top level
Closes gh-38361
2024-04-17 14:37:18 +02:00
Moritz Halbritter
00a10fdc52 Move Docker Compose and Testcontainers to separate section
See gh-38361
2024-04-17 14:05:52 +02:00
Brian Clozel
647a5ec6be Deprecate framework-specific @*Endpoint annotations
Prior to this commit, applications could declare Actuator Endpoints
using web framework-specific annotations, such as `@ServletEndpoint`,
@ControllerEndpoint and @RestControllerEndpoint.

Such annotations are closely tied to the programming model of specific
web technologies, such as Servlet or Spring MVC. Unlike other
`@Endpoint` support, they are not portable and will not work
transparently over blocking/reactive and transports.

Because of the strong adherence of this support with the underlying
infrastructure, it makes it impossible to evolve the implementation of
Actuator support without breaking this use case. The reference
documentation has been advocating for using `@Endpoint` and
`@*Operation` for custom endpoints for a long time now.

This commit deprecates this specific support in favor of the recommended
approach.

Closes gh-31768
2024-04-15 18:58:52 +02:00
Phillip Webb
912c6f617d Update redirect to use correct layout
See gh-40062
2024-04-04 14:41:35 -07:00
Phillip Webb
a836182e31 Add redirect.adoc
Add a redirects page primarily generated from the existing anchor
rewrite files. This page should eventually provide redirect support.

Migration was mostly automated using
https://github.com/philwebb/spring-boot-redirects-generator

See gh-40062
2024-03-26 11:24:20 -07:00
Phillip Webb
dab1afcc77 Fix anchor rewrites in preparation for migration to Antora
Update `anchor-rewrite.properties` to fix a few errors and remove
elements that no longer exist. This commit also fixes a few anchors
in some `.adoc` files.

See gh-40062
2024-03-26 11:18:27 -07:00
Phillip Webb
cd1d223deb Drop empty Antora directories 2024-03-25 08:52:51 -07:00
Andy Wilkinson
ccd22a3109 Document support for Java 22
Closes gh-40047
2024-03-21 17:07:40 +00:00
Phillip Webb
8dd89c1ac7 Migrate spring-boot-docs to Antora
See gh-33766
2024-03-20 15:33:02 -07:00