Skip to content

Commit c6dcc76

Browse files
Fix links in docs
* Fix links in section Previous Releases * Declare some attributes represent document links
1 parent 2ebc7ef commit c6dcc76

26 files changed

+58
-48
lines changed

src/reference/antora/antora.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,15 @@ ext:
1414
asciidoc:
1515
attributes:
1616
attribute-missing: 'warn'
17-
chomp: 'all'
17+
chomp: 'all'
18+
spring-docs: 'https://docs.spring.io'
19+
spring-framework-docs: '{spring-docs}/spring-framework/reference'
20+
spring-integration-docs: '{spring-docs}/spring-integration/reference'
21+
spring-amqp-java-docs: '{spring-docs}/spring-amqp/docs/current/api/org/springframework/amqp'
22+
spring-framework-java-docs: '{spring-docs}/spring/docs/current/javadoc-api/org/springframework'
23+
spring-retry-java-docs: '{spring-docs}/spring-retry/docs/api/current/'
24+
# External projects URLs and related attributes
25+
micrometer-docs: 'https://docs.micrometer.io'
26+
micrometer-tracing-docs: '{micrometer-docs}/tracing/reference/'
27+
micrometer-micrometer-docs: '{micrometer-docs}/micrometer/reference/'
28+
rabbitmq-stream-docs: 'https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle'

src/reference/antora/modules/ROOT/pages/amqp/broker-configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ public Exchange exchange() {
359359
}
360360
----
361361

362-
See the Javadoc for https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp/core/QueueBuilder.html[`org.springframework.amqp.core.QueueBuilder`] and https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp/core/ExchangeBuilder.html[`org.springframework.amqp.core.ExchangeBuilder`] for more information.
362+
See the Javadoc for {spring-amqp-java-docs}/core/QueueBuilder.html[`org.springframework.amqp.core.QueueBuilder`] and {spring-amqp-java-docs}/core/ExchangeBuilder.html[`org.springframework.amqp.core.ExchangeBuilder`] for more information.
363363

364364
Starting with version 2.0, the `ExchangeBuilder` now creates durable exchanges by default, to be consistent with the simple constructors on the individual `AbstractExchange` classes.
365365
To make a non-durable exchange with the builder, use `.durable(false)` before invoking `.build()`.

src/reference/antora/modules/ROOT/pages/amqp/connections.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ public class MyService {
483483
----
484484

485485
It is important to unbind the resource after use.
486-
For more information, see the https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp/rabbit/connection/AbstractRoutingConnectionFactory.html[JavaDoc] for `AbstractRoutingConnectionFactory`.
486+
For more information, see the {spring-amqp-java-docs}/rabbit/connection/AbstractRoutingConnectionFactory.html[JavaDoc] for `AbstractRoutingConnectionFactory`.
487487

488488
Starting with version 1.4, `RabbitTemplate` supports the SpEL `sendConnectionFactorySelectorExpression` and `receiveConnectionFactorySelectorExpression` properties, which are evaluated on each AMQP protocol interaction operation (`send`, `sendAndReceive`, `receive`, or `receiveAndReply`), resolving to a `lookupKey` value for the provided `AbstractRoutingConnectionFactory`.
489489
You can use bean references, such as `@vHostResolver.getVHost(#root)` in the expression.

src/reference/antora/modules/ROOT/pages/amqp/listener-queues.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Container can be initially configured to listen on zero queues.
88
Queues can be added and removed at runtime.
99
The `SimpleMessageListenerContainer` recycles (cancels and re-creates) all consumers when any pre-fetched messages have been processed.
1010
The `DirectMessageListenerContainer` creates/cancels individual consumer(s) for each queue without affecting consumers on other queues.
11-
See the https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp/rabbit/listener/AbstractMessageListenerContainer.html[Javadoc] for the `addQueues`, `addQueueNames`, `removeQueues` and `removeQueueNames` methods.
11+
See the {spring-amqp-java-docs}/rabbit/listener/AbstractMessageListenerContainer.html[Javadoc] for the `addQueues`, `addQueueNames`, `removeQueues` and `removeQueueNames` methods.
1212

1313
If not all queues are available, the container tries to passively declare (and consume from) the missing queues every 60 seconds.
1414

src/reference/antora/modules/ROOT/pages/amqp/management-rest-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
When the management plugin is enabled, the RabbitMQ server exposes a REST API to monitor and configure the broker.
66
A https://github.com/rabbitmq/hop[Java Binding for the API] is now provided.
77
The `com.rabbitmq.http.client.Client` is a standard, immediate, and, therefore, blocking API.
8-
It is based on the https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#spring-web[Spring Web] module and its `RestTemplate` implementation.
8+
It is based on the {spring-framework-docs}/web.html[Spring Web] module and its `RestTemplate` implementation.
99
On the other hand, the `com.rabbitmq.http.client.ReactorNettyClient` is a reactive, non-blocking implementation based on the https://projectreactor.io/docs/netty/release/reference/docs/index.html[Reactor Netty] project.
1010

1111
The hop dependency (`com.rabbitmq:http-client`) is now also `optional`.

src/reference/antora/modules/ROOT/pages/amqp/message-converters.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ It has been replaced by `AbstractJackson2MessageConverter`.
356356

357357
Yet another option is the `MarshallingMessageConverter`.
358358
It delegates to the Spring OXM library's implementations of the `Marshaller` and `Unmarshaller` strategy interfaces.
359-
You can read more about that library https://docs.spring.io/spring/docs/current/spring-framework-reference/html/oxm.html[here].
359+
You can read more about that library {spring-framework-docs}/data-access/oxm.html[here].
360360
In terms of configuration, it is most common to provide only the constructor argument, since most implementations of `Marshaller` also implement `Unmarshaller`.
361361
The following example shows how to configure a `MarshallingMessageConverter`:
362362

src/reference/antora/modules/ROOT/pages/amqp/receiving-messages/async-annotation-driven/enable.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ In this case, and ignoring the RabbitMQ infrastructure setup, the `processOrder`
3737

3838
You can customize the listener container factory to use for each annotation, or you can configure an explicit default by implementing the `RabbitListenerConfigurer` interface.
3939
The default is required only if at least one endpoint is registered without a specific container factory.
40-
See the https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp/rabbit/annotation/RabbitListenerConfigurer.html[Javadoc] for full details and examples.
40+
See the {spring-amqp-java-docs}/rabbit/annotation/RabbitListenerConfigurer.html[Javadoc] for full details and examples.
4141

4242
The container factories provide methods for adding `MessagePostProcessor` instances that are applied after receiving messages (before invoking the listener) and before sending replies.
4343

src/reference/antora/modules/ROOT/pages/amqp/receiving-messages/micrometer-observation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Using Micrometer for observation is now supported, since version 3.0, for the `R
77
Set `observationEnabled` on each component to enable observation; this will disable xref:amqp/receiving-messages/micrometer.adoc[Micrometer Timers] because the timers will now be managed with each observation.
88
When using annotated listeners, set `observationEnabled` on the container factory.
99

10-
Refer to https://docs.micrometer.io/tracing/reference/[Micrometer Tracing] for more information.
10+
Refer to {micrometer-tracing-docs}[Micrometer Tracing] for more information.
1111

1212
To add tags to timers/traces, configure a custom `RabbitTemplateObservationConvention` or `RabbitListenerObservationConvention` to the template or listener container, respectively.
1313

src/reference/antora/modules/ROOT/pages/amqp/receiving-messages/micrometer.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Micrometer Integration
33
:page-section-summary-toc: 1
44

5-
NOTE: This section documents the integration with https://docs.micrometer.io/micrometer/reference/[Micrometer].
5+
NOTE: This section documents the integration with {micrometer-micrometer-docs}[Micrometer].
66
For integration with Micrometer Observation, see xref:amqp/receiving-messages/micrometer-observation.adoc[Micrometer Observation].
77

88
Starting with version 2.2, the listener containers will automatically create and update Micrometer `Timer` s for the listener, if `Micrometer` is detected on the class path, and a single `MeterRegistry` is present in the application context (or exactly one is annotated `@Primary`, such as when using Spring Boot).

src/reference/antora/modules/ROOT/pages/amqp/request-reply.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Those methods are quite useful for request-reply scenarios, since they handle th
66

77
Similar request-reply methods are also available where the `MessageConverter` is applied to both the request and reply.
88
Those methods are named `convertSendAndReceive`.
9-
See the https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp/core/AmqpTemplate.html[Javadoc of `AmqpTemplate`] for more detail.
9+
See the {spring-amqp-java-docs}/core/AmqpTemplate.html[Javadoc of `AmqpTemplate`] for more detail.
1010

1111
Starting with version 1.5.0, each of the `sendAndReceive` method variants has an overloaded version that takes `CorrelationData`.
1212
Together with a properly configured connection factory, this enables the receipt of publisher confirms for the send side of the operation.
13-
See xref:amqp/template.adoc#template-confirms[Correlated Publisher Confirms and Returns] and the https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp/rabbit/core/RabbitOperations.html[Javadoc for `RabbitOperations`] for more information.
13+
See xref:amqp/template.adoc#template-confirms[Correlated Publisher Confirms and Returns] and the {spring-amqp-java-docs}/rabbit/core/RabbitOperations.html[Javadoc for `RabbitOperations`] for more information.
1414

1515
Starting with version 2.0, there are variants of these methods (`convertSendAndReceiveAsType`) that take an additional `ParameterizedTypeReference` argument to convert complex returned types.
1616
The template must be configured with a `SmartMessageConverter`.

0 commit comments

Comments
 (0)