Extract recurring asciidoc links to attributes, cleanup old doc files

This commit extract spring-related links and recurring external links
into asciidoctor attributes to be used by the Antora toolchain.

It notably homogenizes links to:
 - IETF RFCs
 - Java Community Process JSRs
 - the Java API Documentation (on the Java 17 version)
 - Kotlin documentations (on the Kotlinlang.org version)
 - the Spring Boot reference guide (on the `html` version)

This commit also reworks most link attributes to follow a
Project-Category-Misc syntax. For example, `spring-boot-docs` rather
than `docs-spring-boot`.

Finally, it makes an effort to clean up remainders from the previous
documentation toolchain, namely the `docs/asciidoc` folder and 
`modules/ROOT/pages/attributes.adoc` file.

Closes gh-26864
Closes gh-31619
This commit is contained in:
Simon Baslé
2023-11-21 15:59:24 +01:00
committed by GitHub
parent 4cc43b4ddc
commit 8567402969
202 changed files with 594 additions and 2837 deletions

View File

@@ -184,7 +184,7 @@ Kotlin::
+
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
----
// Not possible in Kotlin until https://youtrack.jetbrains.com/issue/KT-22208 is fixed
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed
----
======
@@ -192,7 +192,7 @@ Note that common expectations are always applied and cannot be overridden withou
creating a separate `MockMvc` instance.
When a JSON response content contains hypermedia links created with
https://github.com/spring-projects/spring-hateoas[Spring HATEOAS], you can verify the
{spring-github-org}/spring-hateoas[Spring HATEOAS], you can verify the
resulting links by using JsonPath expressions, as the following example shows:
[tabs]
@@ -220,7 +220,7 @@ Kotlin::
======
When XML response content contains hypermedia links created with
https://github.com/spring-projects/spring-hateoas[Spring HATEOAS], you can verify the
{spring-github-org}/spring-hateoas[Spring HATEOAS], you can verify the
resulting links by using XPath expressions:
[tabs]

View File

@@ -18,7 +18,7 @@ Kotlin::
+
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
----
// Not possible in Kotlin until https://youtrack.jetbrains.com/issue/KT-22208 is fixed
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed
----
======

View File

@@ -113,7 +113,7 @@ Kotlin::
======
Finally, we can verify that a new message was created successfully. The following
assertions use the https://assertj.github.io/doc/[AssertJ] library:
assertions use the {assertj-docs}[AssertJ] library:
[tabs]
======
@@ -268,7 +268,7 @@ Kotlin::
+
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
----
// Not possible in Kotlin until https://youtrack.jetbrains.com/issue/KT-22208 is fixed
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed
----
======

View File

@@ -362,7 +362,7 @@ annotation to look up our submit button with a `css` selector (*input[type=submi
--
Finally, we can verify that a new message was created successfully. The following
assertions use the https://assertj.github.io/doc/[AssertJ] assertion library:
assertions use the {assertj-docs}[AssertJ] assertion library:
--
[tabs]
@@ -562,7 +562,7 @@ Kotlin::
+
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
----
// Not possible in Kotlin until https://youtrack.jetbrains.com/issue/KT-22208 is fixed
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed
----
======

View File

@@ -159,7 +159,7 @@ Kotlin::
+
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
----
// Not possible in Kotlin until https://youtrack.jetbrains.com/issue/KT-22208 is fixed
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed
----
======

View File

@@ -3,9 +3,9 @@
:page-section-summary-toc: 1
The framework's own tests include
{spring-framework-main-code}/spring-test/src/test/java/org/springframework/test/web/servlet/samples[
{spring-framework-code}/spring-test/src/test/java/org/springframework/test/web/servlet/samples[
many sample tests] intended to show how to use MockMvc on its own or through the
{spring-framework-main-code}/spring-test/src/test/java/org/springframework/test/web/servlet/samples/client[
{spring-framework-code}/spring-test/src/test/java/org/springframework/test/web/servlet/samples/client[
WebTestClient]. Browse these examples for further ideas.

View File

@@ -25,7 +25,7 @@ Kotlin::
+
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
----
// Not possible in Kotlin until https://youtrack.jetbrains.com/issue/KT-22208 is fixed
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed
----
======
@@ -53,11 +53,11 @@ Kotlin::
+
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
----
// Not possible in Kotlin until https://youtrack.jetbrains.com/issue/KT-22208 is fixed
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed
----
======
See the javadoc for
{api-spring-framework}/test/web/servlet/setup/ConfigurableMockMvcBuilder.html[`ConfigurableMockMvcBuilder`]
{spring-framework-api}/test/web/servlet/setup/ConfigurableMockMvcBuilder.html[`ConfigurableMockMvcBuilder`]
for a list of all MockMvc builder features or use the IDE to explore the available options.

View File

@@ -21,7 +21,7 @@ for rendering JSON, XML, and other formats through `@ResponseBody` methods.
Alternatively, you may consider the full end-to-end integration testing support from
Spring Boot with `@SpringBootTest`. See the
{docs-spring-boot}/html/spring-boot-features.html#boot-features-testing[Spring Boot Reference Guide].
{spring-boot-docs}/spring-boot-features.html#boot-features-testing[Spring Boot Reference Guide].
There are pros and cons for each approach. The options provided in Spring MVC Test are
different stops on the scale from classic unit testing to full integration testing. To be

View File

@@ -33,6 +33,6 @@ Java::
`WebTestClient` can also connect to a live server and perform full end-to-end integration
tests. This is also supported in Spring Boot where you can
{docs-spring-boot}/html/spring-boot-features.html#boot-features-testing-spring-boot-applications-testing-with-running-server[test a running server].
{spring-boot-docs}/spring-boot-features.html#boot-features-testing-spring-boot-applications-testing-with-running-server[test a running server].