Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a tool to check cross references #38483

Merged
merged 3 commits into from
Jan 31, 2024
+468 −126
Merged

Add a tool to check cross references #38483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b1f04e
Update Asciidoctor Maven plugin to 2.2.5
gsmet Jan 29, 2024
1c65728
Add a tool to check cross references
gsmet Jan 29, 2024
cb5d8e8
Fix some invalid references
gsmet Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<mandrel.image-tag-for-documentation>jdk-21</mandrel.image-tag-for-documentation>

<assembly-maven-plugin.version>3.5.0</assembly-maven-plugin.version>
<asciidoctor-maven-plugin.version>2.0.0</asciidoctor-maven-plugin.version>
<asciidoctor-maven-plugin.version>2.2.5</asciidoctor-maven-plugin.version>
<asciidoctorj-pdf.version>1.5.0-beta.8</asciidoctorj-pdf.version>
<asciidoctor.fail-if>WARN</asciidoctor.fail-if>
<roaster-jdt.version>2.26.0.Final</roaster-jdt.version>
Expand Down Expand Up @@ -3081,6 +3081,26 @@
</environmentVariables>
</configuration>
</execution>
<execution>
<id>check-cross-references</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<skip>${skipDocs}</skip>
<!-- Don't wait for unkillable reference reaper threads -->
<cleanupDaemonThreads>false</cleanupDaemonThreads>
<mainClass>io.quarkus.docs.generation.CheckCrossReferences</mainClass>
<arguments>
<argument>${project.basedir}/target/asciidoc/sources</argument>
<argument>${project.basedir}/target/referenceIndex.yaml</argument>
</arguments>
<environmentVariables>
<MAVEN_CMD_LINE_ARGS>${env.MAVEN_CMD_LINE_ARGS}</MAVEN_CMD_LINE_ARGS>
</environmentVariables>
</configuration>
</execution>
<execution>
<id>assemble-downstream-doc</id>
<phase>prepare-package</phase>
Expand All @@ -3096,6 +3116,7 @@
<argument>-classpath</argument>
<classpath />
<argument>io.quarkus.docs.generation.AssembleDownstreamDocumentation</argument>
<argument>${project.basedir}/target/referenceIndex.yaml</argument>
</arguments>
<workingDirectory>${project.basedir}</workingDirectory>
</configuration>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/building-my-first-extension.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,4 +928,4 @@ As usual, along the path Quarkus simplifies things under the hood (Maven Mojo, b
== Further reading

- xref:writing-extensions.adoc[Writing your own extension] for the full documentation.
- xref:dev-ui-v2.adoc[Quarkus Dev UI] to learn how to support the Dev UI in your extension
- xref:dev-ui.adoc[Quarkus Dev UI] to learn how to support the Dev UI in your extension
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cdi-integration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Attributes of these components are fully controlled by the extensions, i.e. are
Finally, the _deployment is validated_.
For example, the container validates every injection point in the application and fails the build if there is no bean that satisfies the given required type and qualifiers.

TIP: You can see more information about the bootstrap by enabling additional logging. Simply run the Maven build with `-X` or `--debug` and grep the lines that contain `io.quarkus.arc`. In the <<cdi-reference.adoc#dev-mode,development mode>>, you can use `quarkus.log.category."io.quarkus.arc.processor".level=DEBUG` and two special endpoints are also registered automatically to provide some basic debug info in the JSON format.
TIP: You can see more information about the bootstrap by enabling additional logging. Simply run the Maven build with `-X` or `--debug` and grep the lines that contain `io.quarkus.arc`. In <<cdi-reference.adoc#dev_mode,dev mode>>, you can use `quarkus.log.category."io.quarkus.arc.processor".level=DEBUG` and two special endpoints are also registered automatically to provide some basic debug info in the JSON format.

Quarkus build steps can produce and consume various build items and hook into each phase.
In the following sections we will describe all the relevant build items and common scenarios.
Expand Down
9 changes: 5 additions & 4 deletions docs/src/main/asciidoc/cdi-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1072,9 +1072,10 @@ The downside of this approach is that CDI Portable Extensions cannot be supporte
Nevertheless, most of the functionality can be achieved using Quarkus xref:writing-extensions.adoc[extensions].
See the xref:cdi-integration.adoc[integration guide] for more information.

== Development Mode
[[dev_mode]]
== [[development-mode]] Dev mode

In the development mode, two special endpoints are registered automatically to provide some basic debug info in the JSON format:
In dev mode, two special endpoints are registered automatically to provide some basic debug info in the JSON format:

* HTTP GET `/q/arc` - returns the summary; number of beans, config properties, etc.
* HTTP GET `/q/arc/beans` - returns the list of all beans
Expand All @@ -1085,11 +1086,11 @@ In the development mode, two special endpoints are registered automatically to p
* HTTP GET `/q/arc/removed-beans` - returns the list of unused beans removed during build
* HTTP GET `/q/arc/observers` - returns the list of all observer methods

NOTE: These endpoints are only available in the development mode, i.e. when you run your application via `mvn quarkus:dev` (or `./gradlew quarkusDev`).
NOTE: These endpoints are only available in dev mode, i.e. when you run your application via `mvn quarkus:dev` (or `./gradlew quarkusDev`).

=== Monitoring Business Method Invocations and Events

In the development mode, it is also possible to enable monitoring of business method invocations and fired events.
In dev mode, it is also possible to enable monitoring of business method invocations and fired events.
Simply set the `quarkus.arc.dev-mode.monitoring-enabled` configuration property to `true` and explore the relevant Dev UI pages.

[[strict_mode]]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cdi.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ TIP: For more info about events/observers visit https://docs.jboss.org/weld/refe

In this guide, we've covered some basic topics of the Quarkus programming model that is based on the https://jakarta.ee/specifications/cdi/4.0/jakarta-cdi-spec-4.0.html[Jakarta Contexts and Dependency Injection 4.0, window="_blank"] specification.
Quarkus implements the CDI Lite specification, but not CDI Full.
See also <<cdi-reference.adoc#supported_features,the list of supported features>> and <<cdi-reference.adoc#limitations,the list of limitations>>.
See also <<cdi-reference.adoc#supported_features_and_limitations,the list of supported features and limitations>>.
There are also quite a few <<cdi-reference#nonstandard_features,non-standard features>> and <<cdi-reference.adoc#build_time_apis,Quarkus-specific APIs>>.

TIP: If you wish to learn more about Quarkus-specific features and limitations there is a Quarkus xref:cdi-reference.adoc[CDI Reference Guide].
Expand Down
10 changes: 4 additions & 6 deletions docs/src/main/asciidoc/config-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ is to use Quarkus `application.properties`.
Quarkus provides additional extensions which cover other configuration formats and stores:

* xref:config-yaml.adoc[YAML]
* xref:vault.adoc[HashiCorp Vault]
* xref:consul-config.adoc[Consul]
* https://github.com/quarkiverse/quarkus-vault[HashiCorp Vault]
* https://github.com/quarkiverse/quarkus-config-extensions[Consul]
* xref:spring-cloud-config-client.adoc[Spring Cloud]

TIP: It is also possible to create a xref:config-extending-support.adoc#custom-config-source[Custom Config Source].
Expand Down Expand Up @@ -788,10 +788,8 @@ public class MyBeanNoFailure {
== Additional Information

* xref:config-yaml.adoc[YAML ConfigSource Extension]
// Moved to Quarkiverse. There is a redirect to resolve the link
* xref:vault.adoc[HashiCorp Vault ConfigSource Extension]
// Moved to Quarkiverse. There is a redirect to resolve the link
* xref:consul-config.adoc[Consul ConfigSource Extension]
* https://github.com/quarkiverse/quarkus-vault[HashiCorp Vault ConfigSource Extension]
* https://github.com/quarkiverse/quarkus-config-extensions[Consul ConfigSource Extension]
* xref:spring-cloud-config-client.adoc[Spring Cloud ConfigSource Extension]
* xref:config-mappings.adoc[Mapping configuration to objects]
* xref:config-extending-support.adoc[Extending configuration support]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/config-yaml.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ app:

== Profiles

As you can see in the previous snippet, you can use xref:{doc-guides}/config-reference.adoc#profiles[profiles] in YAML.
As you can see in the previous snippet, you can use xref:config-reference.adoc#profiles[profiles] in YAML.


In YAML, keys that begin with `%` are not allowed.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,8 @@ application behaviour at runtime.

* xref:config-reference.adoc[Configuration Reference Guide]
* xref:config-yaml.adoc[YAML ConfigSource Extension]
* xref:vault.adoc[HashiCorp Vault ConfigSource Extension]
* xref:consul-config.adoc[Consul ConfigSource Extension]
* https://github.com/quarkiverse/quarkus-vault[HashiCorp Vault ConfigSource Extension]
* https://github.com/quarkiverse/quarkus-config-extensions[Consul ConfigSource Extension]
* xref:spring-cloud-config-client.adoc[Spring Cloud ConfigSource Extension]
* xref:config-mappings.adoc[Mapping configuration to objects]
* xref:config-extending-support.adoc[Extending configuration support]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/datasource.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@

=== Datasource metrics

If you are using the xref:micrometer.adoc[`quarkus-micrometer`] or xref:smallrye-metrics.adoc[`quarkus-smallrye-metrics`] extension, `quarkus-agroal` can contribute some datasource-related metrics to the metric registry.
If you are using the xref:telemetry-micrometer.adoc[`quarkus-micrometer`] or xref:smallrye-metrics.adoc[`quarkus-smallrye-metrics`] extension, `quarkus-agroal` can contribute some datasource-related metrics to the metric registry.

Check warning on line 526 in docs/src/main/asciidoc/datasource.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/datasource.adoc", "range": {"start": {"line": 526, "column": 1}}}, "severity": "INFO"}
This can be activated by setting the `quarkus.datasource.metrics.enabled` property to `true`.

For the exposed metrics to contain any actual values, a metric collection must be enabled internally by the Agroal mechanisms.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/deploying-to-kubernetes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ implementation("io.quarkus:quarkus-smallrye-health")
----

The values of the generated probes will be determined by the configured health properties: `quarkus.smallrye-health.root-path`, `quarkus.smallrye-health.liveness-path` and `quarkus.smallrye-health.readiness-path`.
More information about the health extension can be found in the relevant xref:microprofile-health.adoc[guide].
More information about the health extension can be found in the relevant xref:smallrye-health.adoc[guide].

=== Customizing the readiness probe
To set the initial delay of the probe to 20 seconds and the period to 45:
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/deploying-to-openshift.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ First, we need a new project that contains the OpenShift extension. This can be
include::{includes}/devtools/create-app.adoc[]

Quarkus offers the ability to automatically generate OpenShift resources based on sane defaults and user supplied configuration.
The OpenShift extension is actually a wrapper extension that brings together the xref:deploying-to-kubernetes.adoc[kubernetes] and xref:container-image.adoc#s2i[container-image-s2i]
extensions with sensible defaults so that it's easier for the user to get started with Quarkus on OpenShift.
The OpenShift extension is actually a wrapper extension that brings configures the xref:deploying-to-kubernetes.adoc[Kubernetes]
extension with sensible defaults so that it's easier for the user to get started with Quarkus on OpenShift.

When we added the OpenShift extension to the command line invocation above, the following dependency was added to the `pom.xml`

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,12 +426,12 @@
Quarkus heavily utilizes https://github.com/wildfly/jandex[Jandex] at build time, to discover various classes or annotations. One immediately recognizable application of this, is CDI bean discovery.
As a result, most of the Quarkus extensions will not work properly if this build time discovery isn't properly setup.

This index is created by default on the project on which Quarkus is configured for, thanks to our Maven and Gradle plugins.

Check warning on line 429 in docs/src/main/asciidoc/getting-started.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.", "location": {"path": "docs/src/main/asciidoc/getting-started.adoc", "range": {"start": {"line": 429, "column": 51}}}, "severity": "INFO"}

However, when working with a multi-module project, be sure to read the `Working with multi-module projects` section of the
xref:maven-tooling.adoc#multi-module-maven[Maven] or xref:gradle-tooling.adoc#multi-module-maven[Gradle] guides.
xref:maven-tooling.adoc#multi-module-maven[Maven] or xref:gradle-tooling.adoc#multi-module-gradle[Gradle] guides.

Check warning on line 432 in docs/src/main/asciidoc/getting-started.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.CaseSensitiveTerms] Use 'Gradle' rather than 'gradle'.

Raw Output:
{"message": "[Quarkus.CaseSensitiveTerms] Use 'Gradle' rather than 'gradle'.", "location": {"path": "docs/src/main/asciidoc/getting-started.adoc", "range": {"start": {"line": 432, "column": 13}}}, "severity": "INFO"}

Check warning on line 432 in docs/src/main/asciidoc/getting-started.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.SentenceLength] Try to keep sentences to an average of 32 words or fewer.

Raw Output:
{"message": "[Quarkus.SentenceLength] Try to keep sentences to an average of 32 words or fewer.", "location": {"path": "docs/src/main/asciidoc/getting-started.adoc", "range": {"start": {"line": 432, "column": 70}}}, "severity": "INFO"}

If you plan to use external modules (for example, an external library for all your domain objects),

Check warning on line 434 in docs/src/main/asciidoc/getting-started.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/getting-started.adoc", "range": {"start": {"line": 434, "column": 64}}}, "severity": "INFO"}
you will need to make these modules known to the indexing process either by adding the Jandex plugin (if you can modify them)
or via the `quarkus.index-dependency` property inside your `application.properties` (useful in cases where you can't modify the module).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/grpc-kubernetes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ By default, the Kubernetes resources do not contain readiness and liveness probe
implementation("io.quarkus:quarkus-smallrye-health")
----

TIP: More information about the health extension can be found in xref:microprofile-health.adoc[the Microprofile Health guide].
TIP: More information about the health extension can be found in xref:smallrye-health.adoc[the SmallRye Health guide].

By the default, this extension will configure the probes to use the HTTP server (which is provided by some extensions like the Quarkus RESTEasy reactive extension). Internally, this probe will also use xref:grpc-service-implementation.adoc#health[the generated gRPC Health services].

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/hibernate-orm.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,10 +907,10 @@

[[metrics]]
== Metrics
Either xref:telemetry-micrometer.adoc[Micrometer] or xref:microprofile-metrics.adoc[SmallRye Metrics] are
Either xref:telemetry-micrometer.adoc[Micrometer] or xref:smallrye-metrics.adoc[SmallRye Metrics] are
capable of exposing metrics that Hibernate ORM collects at runtime. To enable exposure of Hibernate metrics
on the `/q/metrics` endpoint, make sure your project depends on a metrics extension and set the configuration property `quarkus.hibernate-orm.metrics.enabled` to `true`.

Check warning on line 912 in docs/src/main/asciidoc/hibernate-orm.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'verify' rather than 'make sure' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'verify' rather than 'make sure' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/hibernate-orm.adoc", "range": {"start": {"line": 912, "column": 15}}}, "severity": "WARNING"}

Check warning on line 912 in docs/src/main/asciidoc/hibernate-orm.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/hibernate-orm.adoc", "range": {"start": {"line": 912, "column": 159}}}, "severity": "INFO"}
When using link:microprofile-metrics[SmallRye Metrics], metrics will be available under the `vendor` scope.
When using xref:smallrye-metrics.adoc[SmallRye Metrics], metrics will be available under the `vendor` scope.

== Limitations and other things you should know

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/init-tasks.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
application instance only starts once the initialization jobs have finished. With this approach even if an
application has multiple replicas, the initialization logic will only run once.

This approach is reflected in the manifests generated by xref:kubernetes.adoc[Kubernetes extension].
This approach is reflected in the manifests generated by xref:deploying-to-kubernetes.adoc#kubernetes[Kubernetes extension].

== Disabling the feature

Expand Down Expand Up @@ -132,10 +132,10 @@

=== Configuring permissions

For an init container to be able to perform the `wait for job` it needs to be able to perform `get` operations on the job resource.

Check warning on line 135 in docs/src/main/asciidoc/init-tasks.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'needs to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'needs to'.", "location": {"path": "docs/src/main/asciidoc/init-tasks.adoc", "range": {"start": {"line": 135, "column": 67}}}, "severity": "INFO"}
This is done automatically and the generated manifests include the required `Role` and `RoleBinding` resources.

If for any reason additional permissions are required either by the init container or the job, they can be configured with through the xref:deploying-to-kuberentes.adoc#generating-rbac-resources[Kubernetes RBAC configuration].
If for any reason additional permissions are required either by the init container or the job, they can be configured with through the xref:deploying-to-kubernetes.adoc#generating-rbac-resources[Kubernetes RBAC configuration].

**Note**: The application, the init container and the job use the same `ServiceAccount` and therefore, share the same permissions.

Expand Down
11 changes: 5 additions & 6 deletions docs/src/main/asciidoc/pulsar-getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Open the two projects in your favorite IDE.
====
No need to start a Pulsar broker when using the dev mode or for tests.
Quarkus starts a broker for you automatically.
See xref:pulsar.adoc[Dev Services for Pulsar] for details.
See xref:pulsar-dev-services.adoc[Dev Services for Pulsar] for details.
====

== The Quote object
Expand Down Expand Up @@ -268,7 +268,7 @@ The `channel-name` segment must match the value set in the `@Incoming` and `@Out
====
More details about this configuration is available on the https://pulsar.apache.org/docs/3.0.x/concepts-messaging/ section from the Pulsar documentation.
These properties are configured with the prefix `pulsar`.
An exhaustive list of configuration properties is available in xref:pulsar.adoc#pulsar-configuration[Pulsar Reference Guide - Configuration].
An exhaustive list of configuration properties is available in xref:pulsar.adoc#configuration-reference[Pulsar Reference Guide - Configuration].
====

`mp.messaging.incoming.requests.subscriptionInitialPosition=Earliest` instructs the application to start reading the topics from the first message on the topic, when there is no previously acked messages.
Expand Down Expand Up @@ -312,8 +312,7 @@ It will also generate a deserializer for the `Quote` class.
====
.Message Schemas in Pulsar
In this example we used JSON Schema with Pulsar messages.
For more options on Pulsar Schemas, see xref:pulsar.adoc#pulsar-schema[Pulsar Reference Guide - Schema].

For more information on Pulsar Schemas, see xref:pulsar.adoc#pulsar-schema-configuration[Pulsar Reference Guide - Schema].
====

== The HTML page
Expand Down Expand Up @@ -390,7 +389,7 @@ mvn -f pulsar-quickstart-processor quarkus:dev
----

Quarkus starts a Pulsar broker automatically, configures the application and shares the Pulsar broker instance between different applications.
See xref:pulsar.adoc[Dev Services for Pulsar] for more details.
See xref:pulsar-dev-services.adoc[Dev Services for Pulsar] for more details.

Open `http://localhost:8080/quotes.html` in your browser and request some quotes by clicking the button.

Expand Down Expand Up @@ -511,5 +510,5 @@ For the exhaustive list of features and configuration options, check the xref:pu
[NOTE]
====
In this guide we explore Smallrye Reactive Messaging framework to interact with Apache Pulsar.
xref:pulsar.adoc#pulsar-clients[using Pulsar clients directly].
xref:pulsar.adoc#configuring-pulsar-clients[using Pulsar clients directly].
====
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/redis-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,14 @@
* If you are building an imperative (_classic_) Quarkus application integrating with Redis: use `io.quarkus.redis.datasource.RedisDataSource`.
* If you are building a reactive Quarkus application integrating with Redis: use `io.quarkus.redis.datasource.ReactiveRedisDataSource`.
* If you need fine-grain control, or execute commands in a generic way: use `io.vertx.mutiny.redis.client.RedisAPI`
* If you have existing Vert.x code, use `io.vertx.redis.client.RedisAPI`

Check warning on line 87 in docs/src/main/asciidoc/redis-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/redis-reference.adoc", "range": {"start": {"line": 87, "column": 72}}}, "severity": "INFO"}
* If you need to emit custom commands, you can either use the data sources (reactive or imperative) or the `io.vertx.mutiny.redis.client.Redis`.

== Inject the default and named clients
[[default-and-named-clients]]
== [[inject-the-default-and-named-clients]] Inject the default and named clients

This extension lets you configure a _default_ Redis client/data sources or _named_ ones.
The latter is essential when you need to connect to multiple Redis instances.

Check warning on line 94 in docs/src/main/asciidoc/redis-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/redis-reference.adoc", "range": {"start": {"line": 94, "column": 23}}}, "severity": "INFO"}

The default connection is configured using the `quarkus.redis.*` properties.
For example, to configure the default Redis client, use:
Expand Down
4 changes: 1 addition & 3 deletions docs/src/main/asciidoc/resteasy-reactive.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,9 +394,8 @@ public class Endpoint {
----
<1> `BeanParam` is required to comply with the Jakarta REST specification so that libraries like OpenAPI can introspect the parameters.

=== Declaring URI parameters

[[uri-parameters]]
=== [[declaring-uri-parameters]] Declaring URI parameters

You can declare URI parameters and use regular expressions in your path, so for instance
the following endpoint will serve requests for `/hello/stef/23` and `/hello` but not
Expand Down Expand Up @@ -435,7 +434,6 @@ its HTTP representation to the Java type of the parameter.
The following parameter types will be supported out of the box:

[[resource-types]]

.Request body parameter types
|===
|Type|Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/security-customization.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ public class RolesAugmentor implements SecurityIdentityAugmentor {
}
----

Here is another example showing how to use the client certificate available in the current xref:security-authentication-mechanisms.adoc#mutual-TLS-authentication[mutual TLS (mTLS) authentication] request to add more roles:
Here is another example showing how to use the client certificate available in the current xref:security-authentication-mechanisms.adoc#mutual-tls[mutual TLS (mTLS) authentication] request to add more roles:

[source,java]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/security-jwt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -817,7 +817,7 @@ To prevent it, set `quarkus.smallrye-jwt.blocking-authentication=true`.

=== Token Propagation

Please see the xref:security-openid-connect-client.adoc#token-propagation[Token Propagation] section about the Bearer access token propagation to the downstream services.
Please see the xref:security-openid-connect-client-reference.adoc#token-propagation[Token Propagation] section about the Bearer access token propagation to the downstream services.

[[integration-testing]]
=== Testing
Expand Down
Loading
Loading