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

[3.2] Additional backports for downstream documentation #38724

Merged
merged 3 commits into from
Feb 12, 2024
Merged

[3.2] Additional backports for downstream documentation #38724

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
639f168
Move title attribute to icon
gsmet Feb 7, 2024
11f5d79
Replace [#anchors] with [[anchors]] in downstream documentation
gsmet Feb 7, 2024
7d2ba11
Use [[anchor]] format consistently
gsmet Feb 7, 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
2 changes: 1 addition & 1 deletion core/processor/src/main/java/io/quarkus/annotation/processor/Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ final public class Constants {
public static final String DURATION_NOTE_ANCHOR = String.format("duration-note-anchor-{%s}",
SUMMARY_TABLE_ID_VARIABLE);
public static final String MEMORY_SIZE_NOTE_ANCHOR = "memory-size-note-anchor";
public static final String MORE_INFO_ABOUT_TYPE_FORMAT = " link:#%s[icon:question-circle[], title=More information about the %s format]";
public static final String MORE_INFO_ABOUT_TYPE_FORMAT = " link:#%s[icon:question-circle[title=More information about the %s format]]";
public static final String DURATION_INFORMATION = String.format(Constants.MORE_INFO_ABOUT_TYPE_FORMAT,
Constants.DURATION_NOTE_ANCHOR, Duration.class.getSimpleName());
public static final String MEMORY_SIZE_INFORMATION = String.format(Constants.MORE_INFO_ABOUT_TYPE_FORMAT,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amqp-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ mp.messaging.incoming.people-out.link-name=people

More details about the AMQP Address model can be found in the https://activemq.apache.org/components/artemis/documentation/2.0.0/address-model.html[Artemis documentation].

[#blocking-processing]
[[blocking-processing]]
=== Execution model and Blocking processing

Reactive Messaging invokes your method on an I/O thread.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/azure-functions-http.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The Azure Functions `host.json` deployment descriptor is automatically
generated, but if you need to override it, declare it in the root directory of the project and
rerun the build when you are ready.

[#config-azure-paths]
[[config-azure-paths]]
== Configuring Root Paths

The default route prefix for an Azure Function is `/api`. All of your Jakarta REST, Servlet, Reactive Routes, and xref:funqy-http.adoc[Funqy HTTP] endpoints must
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/building-native-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ It is also possible to re-run the tests against a native executable that has alr
If the process cannot find the native image for some reason, or you want to test a native image that is no longer in the
target directory you can specify the executable with the `-Dnative.image.path=` system property.

[#container-runtime]
[[container-runtime]]
== Creating a Linux executable without GraalVM installed

IMPORTANT: Before going further, be sure to have a working container runtime (Docker, podman) environment. If you use Docker
Expand Down Expand Up @@ -413,7 +413,7 @@ These are regular Quarkus config properties, so if you always want to build in a
it is recommended you add these to your `application.properties` in order to avoid specifying them every time.
====

[#tip-quarkus-native-remote-container-build]
[[tip-quarkus-native-remote-container-build]]
[TIP]
====
If you see the following invalid path error for your application JAR when trying to create a native executable using a container build, even though your JAR was built successfully, you're most likely using a remote daemon for your container runtime.
Expand Down Expand Up @@ -557,7 +557,7 @@ CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
The UBI minimal image is bigger than the micro one mentioned above.
It contains more utilities such as the `microdnf` package manager.

[#multistage-docker]
[[multistage-docker]]
=== Using a multi-stage Docker build

The previous section showed you how to build a native executable using Maven or Gradle, but it requires you to have created the native executable first.
Expand Down
8 changes: 4 additions & 4 deletions docs/src/main/asciidoc/cache.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ Congratulations! You just added application data caching to your Quarkus applica
Do you want to learn more about the Quarkus application data caching abilities?
The following sections will show you everything there is to know about it.

[#annotations-api]
[[annotations-api]]
== Caching using annotations

Quarkus offers a set of annotations that can be used in a CDI managed bean to enable caching abilities.
Expand Down Expand Up @@ -327,7 +327,7 @@ method annotated with `@CacheResult` or `@CacheInvalidate`.

This annotation is optional and should only be used when some method arguments are NOT part of the cache key.

[#cache-keys-building-logic]
[[cache-keys-building-logic]]
=== Cache keys building logic

Cache keys are built by the annotations API using the following logic:
Expand Down Expand Up @@ -485,7 +485,7 @@ public class CachedService {
<3> This key generator is not a CDI bean.
<4> The `@CacheKey` annotation will be ignored when the `foo` cache data is invalidated, but `param1` will be the cache key when the `bar` cache data is invalidated.

[#programmatic-api]
[[programmatic-api]]
== Caching using the programmatic API

Quarkus also offers a programmatic API which can be used to store, retrieve or delete values from any cache declared using the annotations API.
Expand Down Expand Up @@ -962,7 +962,7 @@ public class CacheClearer {
}
----

[#negative-cache]
[[negative-cache]]
== Negative caching and nulls

Sometimes one wants to cache the result of an (expensive) remote call.
Expand Down
10 changes: 5 additions & 5 deletions docs/src/main/asciidoc/container-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Quarkus provides extensions for building (and pushing) container images. Current

== Container Image extensions

[#jib]
[[jib]]
=== Jib

The extension `quarkus-container-image-jib` is powered by https://github.com/GoogleContainerTools/jib[Jib] for performing container image builds.
Expand Down Expand Up @@ -104,7 +104,7 @@ this property needs to be known very early on in the build process.
Quarkus supports generating and including an link:https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#application-class-data-sharing[Application Class Data Sharing] archive when generating a container image using Jib.
See the xref:appcds.adoc[AppCDS documentation] for more details.

[#docker]
[[docker]]
=== Docker

The extension `quarkus-container-image-docker` is using the Docker binary and the generated Dockerfiles under `src/main/docker` in order to perform Docker builds.
Expand All @@ -118,7 +118,7 @@ The `quarkus-container-image-docker` extension is capable of https://docs.docker

NOTE: `docker buildx build` ONLY supports https://docs.docker.com/engine/reference/commandline/buildx_build/#load[loading the result of a build] to `docker images` when building for a single platform. Therefore, if you specify more than one argument in the `quarkus.docker.buildx.platform` property, the resulting images will not be loaded into `docker images`. If `quarkus.docker.buildx.platform` is omitted or if only a single platform is specified, it will then be loaded into `docker images`.

[#openshift]
[[openshift]]
=== OpenShift

The extension `quarkus-container-image-openshift` is using OpenShift binary builds in order to perform container builds inside the OpenShift cluster.
Expand All @@ -135,7 +135,7 @@ OpenShift builds require creating a `BuildConfig` and two `ImageStream` resource
The creation of such objects is being taken care of by the Quarkus Kubernetes extension.


[#buildpack]
[[buildpack]]
=== Buildpack

The extension `quarkus-container-image-buildpack` is using buildpacks in order to perform container image builds.
Expand Down Expand Up @@ -246,7 +246,7 @@ In addition to the generic container image options, the `container-image-jib` al

include::{generated-dir}/config/quarkus-container-image-jib.adoc[opts=optional, leveloffset=+1]

[#DockerOptions]
[[DockerOptions]]
=== Docker Options

In addition to the generic container image options, the `container-image-docker` also provides the following options:
Expand Down
10 changes: 5 additions & 5 deletions 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 @@ -20,7 +20,7 @@ Finally, when either one of container image extensions is present (see the xref:
include::{includes}/prerequisites.adoc[]
* Access to a Kubernetes cluster (Minikube is a viable option)

[#kubernetes]
[[kubernetes]]
== Kubernetes

Let's create a new project that contains both the Kubernetes and Jib extensions:
Expand Down Expand Up @@ -363,7 +363,7 @@ quarkus.kubernetes.annotations.foo=bar
quarkus.kubernetes.annotations."app.quarkus/id"=42
----

[#env-vars]
[[env-vars]]
==== Environment variables

Kubernetes provides multiple ways of defining environment variables:
Expand Down Expand Up @@ -501,7 +501,7 @@ A conflict between two definitions, e.g. mistakenly assigning both a value and s

Similarly, two redundant definitions, e.g. defining an injection from the same secret twice, will not cause an issue but will indeed report a warning to let you know that you might not have intended to duplicate that definition.

[#env-vars-backwards]
[[env-vars-backwards]]
===== Backwards compatibility

Previous versions of the Kubernetes extension supported a different syntax to add environment variables. The older syntax is still supported but is deprecated, and it's advised that you migrate to the new syntax.
Expand Down Expand Up @@ -1029,7 +1029,7 @@ The full list of the Kubernetes client configuration properties is provided belo
:no-duration-note: true
include::{generated-dir}/config/quarkus-kubernetes-client.adoc[opts=optional, leveloffset=+1]

[#openshift]
[[openshift]]
=== OpenShift

One way to deploy an application to OpenShift is to use s2i (source to image) to create an image stream from the source and then deploy the image stream:
Expand Down Expand Up @@ -1140,7 +1140,7 @@ The OpenShift resources can be customized in a similar approach with Kubernetes.
:no-duration-note: true
include::{generated-dir}/config/quarkus-openshift-openshift-config.adoc[opts=optional, leveloffset=+1]

[#knative]
[[knative]]
=== Knative

To enable the generation of Knative resources, you need to include Knative in the target platforms:
Expand Down
6 changes: 3 additions & 3 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 @@ -90,7 +90,7 @@ include::{includes}/devtools/build.adoc[]

TIP: If you want to test your application immediately then set the `quarkus.openshift.route.expose` config property to `true` to <<exposing_routes,expose the service automatically>>, e.g. add `-Dquarkus.openshift.route.expose=true` to the command above.

[#re-deploy-with-service-binding]
[[re-deploy-with-service-binding]]
NOTE: When using `DeploymentConfig` and xref:deploying-to-kubernetes.adoc#service_binding[Service Binding], re-deploying might remove the configuration added by OpenShift to allow service discovery. A new container image build will trigger a refresh of the Quarkus app in OpenShift: `-Dquarkus.container-image.build=true` which might be enough in most situations. If you need to update the OpenShift resources, you need to delete the binding first to create it again after new deployment.

This command will build your application locally, then trigger a container image build and finally apply the generated OpenShift resources automatically.
Expand Down Expand Up @@ -254,7 +254,7 @@ To add an annotation in the generated resources:
quarkus.openshift.annotations.foo=bar
----

[#env-vars]
[[env-vars]]
=== Environment variables

OpenShift provides multiple ways of defining environment variables:
Expand Down Expand Up @@ -438,7 +438,7 @@ A conflict between two definitions, e.g. mistakenly assigning both a value and s

Similarly, two redundant definitions, e.g. defining an injection from the same secret twice, will not cause an issue but will indeed report a warning to let you know that you might not have intended to duplicate that definition.

[#env-vars-backwards]
[[env-vars-backwards]]
===== Backwards compatibility

Previous versions of the OpenShift extension supported a different syntax to add environment variables. The older syntax is still supported but is deprecated, and it's advised that you migrate to the new syntax.
Expand Down
18 changes: 9 additions & 9 deletions docs/src/main/asciidoc/extension-codestart.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,14 +346,14 @@

== Specific topics

[#org-acme-package]
[[org-acme-package]]
=== `org.acme` placeholder for package name

You have to use `org.acme` as the package name in your extension codestart sources. In the generated project, the user specified package (or Group) will be used (and automatically replace `org.acme`).

Check warning on line 352 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'codestart'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'codestart'?", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 352, "column": 39}}}, "severity": "WARNING"}

The package will be automatically replaced in all the source files (.java, .kt, .scala). The package directory will also be automatically adjusted. If for some reason, another type of file needs the user package name then you should use a <<qute-templates>> for it and the `{project.package-name}` data placeholder (https://github.com/quarkusio/quarkus/blob/main/devtools/project-core-extension-codestarts/src/main/resources/codestarts/quarkus/extension-codestarts/grpc-codestart/base/src/main/proto/hello.tpl.qute.proto#L4[find an example in the grpc proto file, window="_blank"]).

Check warning on line 354 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'placeholder for package name'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'placeholder for package name'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 354, "column": 49}}}, "severity": "INFO"}

[#codestart-yml]
[[codestart-yml]]
=== codestart.yml

[source,yaml]
Expand All @@ -375,8 +375,8 @@
path: /some-path
----

[#directory-structure]
[[directory-structure]]

Check warning on line 378 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'Directory Structure'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Directory Structure'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 378, "column": 2}}}, "severity": "INFO"}
=== Directory Structure

Check warning on line 379 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'codestart.yml'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'codestart.yml'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 379, "column": 6}}}, "severity": "INFO"}

NOTE: `codestart.yml` is the only required file.

Expand Down Expand Up @@ -424,13 +424,13 @@
=== Naming Convention for files

* `.tpl.qute` will be processed with Qute and can use data (`.tpl.qute` will be removed from the output file name).
* certain common files, such as `readme.md`, `src/main/resources/application.yml`, `src/main/resources/META-INF/resources/index.html` are generated from the collected fragments found in the selected codestarts for the project

Check warning on line 427 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'codestarts'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'codestarts'?", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 427, "column": 173}}}, "severity": "WARNING"}
* other files are copied.

[#qute-templates]
[[qute-templates]]
=== Templates (Qute)

Codestarts may use Qute templates `MyClass.tpl.qute.java` for dynamic rendering.

Check warning on line 433 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'Codestarts'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'Codestarts'?", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 433, "column": 1}}}, "severity": "WARNING"}

Check warning on line 433 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses it.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses it.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 433, "column": 12}}}, "severity": "WARNING"}

Those templates are able to use data which contains:

Expand All @@ -439,10 +439,10 @@
* The user input
* Some dynamically generated data (e.g. `dependencies` and `test-dependencies`)

[#readme-md]
[[readme-md]]

Check warning on line 442 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses it.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses it.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 442, "column": 7}}}, "severity": "WARNING"}
=== README.md

Check warning on line 443 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'README.md'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'README.md'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 443, "column": 4}}}, "severity": "INFO"}

You may add a `README.md` or `README.tpl.qute.md` in the `base` directory, it will be appended to the others.

Check warning on line 445 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses it.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses it.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 445, "column": 5}}}, "severity": "WARNING"}
So just add the info relative to your extension codestart.

base/README.tpl.qute.md
Expand All @@ -455,7 +455,7 @@

NOTE: The `{#include readme-header /}` will use a template located in the Quarkus project codestart which displays standard info from the `codestart.yml` metadata.

[#app-config]
[[app-config]]
=== application config application.yml

As a convention, you should always provide the Quarkus configuration as a yaml file (`base/src/main/resources/application.yml`).
Expand All @@ -465,7 +465,7 @@
* merged with the other extension codestarts configs
* automatically converted to the selected config type (yaml or properties) at generation time depending on the selected extensions

[#index-html]
[[index-html]]
=== index.html and web extension codestarts

Extension codestarts may provide a snippet for the generated index.html by adding this file:
Expand All @@ -478,7 +478,7 @@

NOTE: The `{#include index-entry /}` will use a template located in the Quarkus project codestart which displays standard info from the `codestart.yml` metadata.

[#integration-test]
[[integration-test]]
=== Integration test

An extension is available to help test extension codestarts `QuarkusCodestartTest`:
Expand All @@ -503,10 +503,10 @@

The https://github.com/quarkusio/quarkus/blob/main/integration-tests/devtools/src/test/java/io/quarkus/devtools/codestarts/quarkus/ConfigYamlCodestartTest.java[ ConfigYamlCodestartTest, window="_blank"] is a good example in Quarkus core.

[#snapshot-testing]
[[snapshot-testing]]
==== Snapshot testing

Snapshot testing is a way to make sure the content generated by a test doesn't change from one revision to another, i.e. between commits. That means, the generated content for each commit needs to be immutable and deterministic (this is the reason for using mocked data). To be able to perform such checks, we auto-generate snapshots of the generated content and commit them as the references of the expected output for subsequent test runs. When the templates change, we also commit the induced snapshots changes. This way, during the review, we can make sure the applied code changes have the expected effects on the generated output.

Check failure on line 509 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'i'.

Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'i'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 509, "column": 117}}}, "severity": "ERROR"}

The extension provides helpers to check the content:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/extension-registry-user.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Some options need to be set:

Here is an example on how it should look like:

[#img-nexus]
[[img-nexus]]
.Nexus Repository Manager: Add Proxy Repository
image:registry-nexus-repository.png[Nexus Repository Proxy]

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/getting-started-testing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1061,7 +1061,7 @@ If you are using the `quarkus-hibernate-orm-panache` or `quarkus-mongodb-panache

If you are using Quarkus Security, check out the xref:security-testing.adoc[Testing Security] section for information on how to easily test security features of the application.

[#quarkus-test-resource]
[[quarkus-test-resource]]
== Starting services before the Quarkus application starts

A very common need is to start some services on which your Quarkus application depends, before the Quarkus application starts for testing. To address this need, Quarkus provides `@io.quarkus.test.common.QuarkusTestResource` and `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`.
Expand Down Expand Up @@ -1231,7 +1231,7 @@ guide except injecting into tests (and the native executable runs in a separate

This is covered in the xref:building-native-image.adoc[Native Executable Guide].

[#quarkus-integration-test]
[[quarkus-integration-test]]
== Using `@QuarkusIntegrationTest`

`@QuarkusIntegrationTest` should be used to launch and test the artifact produced by the Quarkus build, and supports testing a jar (of whichever type), a native image or container image.
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 @@ -462,7 +462,7 @@ NOTE: If you want to deploy your application somewhere (typically in a container

NOTE: Before running the application, don't forget to stop the hot reload mode (hit `CTRL+C`), or you will have a port conflict.

[#banner]
[[banner]]
== Configuring the banner

By default, when a Quarkus application starts (in regular or dev mode), it will display an ASCII art banner. The banner can be disabled by setting `quarkus.banner.enabled=false` in `application.properties`,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/infinispan-client-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ for Kubernetes deployments, Infinispan Console,
https://infinispan.org/docs/stable/titles/rest/rest.html#rest_v2_protobuf_schemas[REST API] or the
https://infinispan.org/docs/stable/titles/encoding/encoding.html#registering-sci-remote-caches_marshalling[Hot Rod Java Client].

[#infinispan-annotations-api]
[[infinispan-annotations-api]]
== Caching using annotations

The Infinispan Client extension offers a set of annotations that can be used in a CDI managed bean to enable caching abilities with Infinispan.
Expand Down
8 changes: 4 additions & 4 deletions docs/src/main/asciidoc/jms.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The guide can be used either via the Apache Qpid JMS AMQP client as detailed imm
alternatively with the Apache ActiveMQ Artemis JMS client given some different configuration
as <<artemis-jms, detailed later>>.

[#qpid-jms-amqp]
[[qpid-jms-amqp]]
== Qpid JMS - AMQP

In the detailed steps below we will use the https://qpid.apache.org/components/jms/[Apache Qpid JMS]
Expand Down Expand Up @@ -74,7 +74,7 @@ This command generates a new project importing the quarkus-qpid-jms extension:
implementation("org.amqphub.quarkus:quarkus-qpid-jms")
----

[#starting-the-broker]
[[starting-the-broker]]
=== Starting the broker

Then, we need an AMQP broker. In this case we will use an Apache ActiveMQ Artemis server.
Expand Down Expand Up @@ -293,7 +293,7 @@ quarkus.qpid-jms.password=quarkus

More detail about the configuration are available in the https://github.com/amqphub/quarkus-qpid-jms#configuration[Quarkus Qpid JMS] documentation.

[#get-it-running]
[[get-it-running]]
=== Get it running

If you followed the instructions, you should have the Artemis server running.
Expand Down Expand Up @@ -325,7 +325,7 @@ Open `http://localhost:8080/prices.html` in your browser.
'''


[#artemis-jms]
[[artemis-jms]]
== Artemis JMS

The above steps detailed using the Qpid JMS AMQP client, however the guide can also be used
Expand Down
Loading
Loading