Skip to content

Commit 60243db

Browse files
committed
Polish asciidoc attributes
1 parent fb1f0ec commit 60243db

File tree

8 files changed

+20
-24
lines changed

8 files changed

+20
-24
lines changed

framework-docs/src/docs/asciidoc/attributes.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:chomp: default headers packages
1+
:chomp: default headers packages
22
:docs-site: https://docs.spring.io
33
// Spring Framework
44
:docs-spring-framework: {docs-site}/spring-framework/docs/{spring-version}
@@ -10,8 +10,9 @@
1010
// Spring portfolio Links
1111
:docs-spring-boot: {docs-site}/spring-boot/docs/current/reference
1212
:docs-spring-gemfire: {docs-site}/spring-gemfire/docs/current/reference
13+
:docs-spring-security: {docs-site}/spring-security/reference
1314
// Third-party Links
15+
:docs-graalvm: https://www.graalvm.org/22.3/reference-manual
1416
:gh-rsocket: https://github.com/rsocket
1517
:gh-rsocket-extensions: {gh-rsocket}/rsocket/blob/master/Extensions
1618
:gh-rsocket-java: {gh-rsocket}/rsocket-java
17-
:doc-graalvm: https://www.graalvm.org/22.3/reference-manual

framework-docs/src/docs/asciidoc/core/core-aot.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ include::code:SpellCheckServiceTests[tag=hintspredicates]
272272
With `RuntimeHintsPredicates`, we can check for reflection, resource, serialization or proxy generation hints.
273273
This approach works well for unit tests but implies that the runtime behavior of a component is well known.
274274

275-
You can learn more about the global runtime behavior of an application by running its test suite (or the app itself) with the {doc-graalvm}/native-image/metadata/AutomaticMetadataCollection/[GraalVM tracing agent].
275+
You can learn more about the global runtime behavior of an application by running its test suite (or the app itself) with the {docs-graalvm}/native-image/metadata/AutomaticMetadataCollection/[GraalVM tracing agent].
276276
This agent will record all relevant calls requiring GraalVM hints at runtime and write them out as JSON configuration files.
277277

278278
For more targeted discovery and testing, Spring Framework ships a dedicated module with core AOT testing utilities, `"org.springframework:spring-core-test"`.

framework-docs/src/docs/asciidoc/core/core-beans.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ For information about using other forms of metadata with the Spring container, s
113113
provided by the Spring JavaConfig project became part of the core Spring Framework.
114114
Thus, you can define beans external to your application classes by using Java rather
115115
than XML files. To use these new features, see the
116-
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Configuration.html[`@Configuration`],
117-
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Bean.html[`@Bean`],
118-
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Import.html[`@Import`],
119-
and https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/DependsOn.html[`@DependsOn`] annotations.
116+
{api-spring-framework}/context/annotation/Configuration.html[`@Configuration`],
117+
{api-spring-framework}/context/annotation/Bean.html[`@Bean`],
118+
{api-spring-framework}/context/annotation/Import.html[`@Import`],
119+
and {api-spring-framework}/context/annotation/DependsOn.html[`@DependsOn`] annotations.
120120

121121
Spring configuration consists of at least one and typically more than one bean
122122
definition that the container must manage. XML-based configuration metadata configures these

framework-docs/src/docs/asciidoc/web/webflux-cors.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[[webflux-cors]]
22
= CORS
3-
:doc-spring-security: {docs-site}/spring-security/reference
43
[.small]#<<web.adoc#mvc-cors, Web MVC>>#
54

65
Spring WebFlux lets you handle CORS (Cross-Origin Resource Sharing). This section
@@ -310,7 +309,7 @@ You can apply CORS support through the built-in
310309
good fit with <<webflux-fn, functional endpoints>>.
311310

312311
NOTE: If you try to use the `CorsFilter` with Spring Security, keep in mind that Spring
313-
Security has {doc-spring-security}/servlet/integrations/cors.html[built-in support] for
312+
Security has {docs-spring-security}/servlet/integrations/cors.html[built-in support] for
314313
CORS.
315314

316315
To configure the filter, you can declare a `CorsWebFilter` bean and pass a

framework-docs/src/docs/asciidoc/web/webflux.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[[webflux]]
22
:chapter: webflux
33
= Spring WebFlux
4-
:doc-spring-security: {docs-site}/spring-security/reference
54

65
The original web framework included in the Spring Framework, Spring Web MVC, was
76
purpose-built for the Servlet API and Servlet containers. The reactive-stack web framework,
@@ -3743,10 +3742,10 @@ The https://spring.io/projects/spring-security[Spring Security] project provides
37433742
for protecting web applications from malicious exploits. See the Spring Security
37443743
reference documentation, including:
37453744

3746-
* {doc-spring-security}/reactive/configuration/webflux.html[WebFlux Security]
3747-
* {doc-spring-security}/reactive/test/index.html[WebFlux Testing Support]
3748-
* {doc-spring-security}/features/exploits/csrf.html#csrf-protection[CSRF protection]
3749-
* {doc-spring-security}/features/exploits/headers.html[Security Response Headers]
3745+
* {docs-spring-security}/reactive/configuration/webflux.html[WebFlux Security]
3746+
* {docs-spring-security}/reactive/test/index.html[WebFlux Testing Support]
3747+
* {docs-spring-security}/features/exploits/csrf.html#csrf-protection[CSRF protection]
3748+
* {docs-spring-security}/features/exploits/headers.html[Security Response Headers]
37503749

37513750

37523751

framework-docs/src/docs/asciidoc/web/webmvc-cors.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[[mvc-cors]]
22
= CORS
3-
:doc-spring-security: {docs-site}/spring-security/reference
43
[.small]#<<web-reactive.adoc#webflux-cors, WebFlux>>#
54

65
Spring MVC lets you handle CORS (Cross-Origin Resource Sharing). This section
@@ -336,7 +335,7 @@ You can apply CORS support through the built-in
336335
{api-spring-framework}/web/filter/CorsFilter.html[`CorsFilter`].
337336

338337
NOTE: If you try to use the `CorsFilter` with Spring Security, keep in mind that Spring
339-
Security has {doc-spring-security}/servlet/integrations/cors.html[built-in support] for
338+
Security has {docs-spring-security}/servlet/integrations/cors.html[built-in support] for
340339
CORS.
341340

342341
To configure the filter, pass a `CorsConfigurationSource` to its constructor, as the

framework-docs/src/docs/asciidoc/web/webmvc.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[[mvc]]
22
:chapter: mvc
33
= Spring Web MVC
4-
:doc-spring-security: {docs-site}/spring-security/reference
54

65
Spring Web MVC is the original web framework built on the Servlet API and has been included
76
in the Spring Framework from the very beginning. The formal name, "Spring Web MVC,"
@@ -5073,10 +5072,10 @@ The https://spring.io/projects/spring-security[Spring Security] project provides
50735072
for protecting web applications from malicious exploits. See the Spring Security
50745073
reference documentation, including:
50755074

5076-
* {doc-spring-security}/servlet/integrations/mvc.html[Spring MVC Security]
5077-
* {doc-spring-security}/servlet/test/mockmvc/setup.html[Spring MVC Test Support]
5078-
* {doc-spring-security}/features/exploits/csrf.html#csrf-protection[CSRF protection]
5079-
* {doc-spring-security}/features/exploits/headers.html[Security Response Headers]
5075+
* {docs-spring-security}/servlet/integrations/mvc.html[Spring MVC Security]
5076+
* {docs-spring-security}/servlet/test/mockmvc/setup.html[Spring MVC Test Support]
5077+
* {docs-spring-security}/features/exploits/csrf.html#csrf-protection[CSRF protection]
5078+
* {docs-spring-security}/features/exploits/headers.html[Security Response Headers]
50805079

50815080
https://hdiv.org/[HDIV] is another web security framework that integrates with Spring MVC.
50825081

framework-docs/src/docs/asciidoc/web/websocket.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[[websocket]]
22
= WebSockets
3-
:doc-spring-security: {docs-site}/spring-security/reference
43
[.small]#<<web-reactive.adoc#webflux-websocket, WebFlux>>#
54

65
This part of the reference documentation covers support for Servlet stack, WebSocket
@@ -627,7 +626,7 @@ response. By default, the Spring Security Java configuration sets it to `DENY`.
627626
In 3.2, the Spring Security XML namespace does not set that header by default
628627
but can be configured to do so. In the future, it may set it by default.
629628
630-
See {doc-spring-security}/features/exploits/headers.html#headers-default[Default Security Headers]
629+
See {docs-spring-security}/features/exploits/headers.html#headers-default[Default Security Headers]
631630
of the Spring Security documentation for details on how to configure the
632631
setting of the `X-Frame-Options` header. You can also see
633632
https://github.com/spring-projects/spring-security/issues/2718[gh-2718]
@@ -1811,7 +1810,7 @@ its own implementation of `WebSocketMessageBrokerConfigurer` that is marked with
18111810
=== Authorization
18121811

18131812
Spring Security provides
1814-
{doc-spring-security}/servlet/integrations/websocket.html#websocket-authorization[WebSocket sub-protocol authorization]
1813+
{docs-spring-security}/servlet/integrations/websocket.html#websocket-authorization[WebSocket sub-protocol authorization]
18151814
that uses a `ChannelInterceptor` to authorize messages based on the user header in them.
18161815
Also, Spring Session provides
18171816
https://docs.spring.io/spring-session/reference/web-socket.html[WebSocket integration]

0 commit comments

Comments
 (0)