Merge pull request quarkusio#36985 from gsmet/doc-links

Generate a file with relations between guides
gsmet · Nov 10, 2023 · 90f3f6d · 90f3f6d
2 parents 9161ff7 + da2b6ca
commit 90f3f6d
Show file tree

Hide file tree

Showing 38 changed files with 145 additions and 39 deletions.
diff --git a/docs/src/main/asciidoc/amqp-dev-services.adoc b/docs/src/main/asciidoc/amqp-dev-services.adoc
@@ -8,7 +8,7 @@ include::_attributes.adoc[]
 :categories: messaging
 :summary: Start AMQP automatically in dev and test modes.
 :extensions: io.quarkus:quarkus-smallrye-reactive-messaging-amqp
-:topics: messaging,amqp,devservices,tooling,testing,devmode
+:topics: messaging,amqp,dev-services,testing,dev-mode
 
 Dev Services for AMQP automatically starts an AMQP 1.0 broker in dev mode and when running tests.
 So, you don't have to start a broker manually.

diff --git a/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc b/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: messaging
 :summary: Start Apicurio Registry automatically in dev and test modes.
-:topics: messaging,kafka,apicurio,registry,devservices,tooling,testing,devmode
+:topics: messaging,kafka,apicurio,registry,dev-services,dev-mode,testing
 :extensions: io.quarkus:quarkus-apicurio-registry-avro,io.quarkus:quarkus-smallrye-reactive-messaging-kafka
 
 If an extension for schema registry, such as `quarkus-apicurio-registry-avro` or `quarkus-confluent-registry-avro`, is present, Dev Services for Apicurio Registry automatically starts an Apicurio Registry instance in dev mode and when running tests.

diff --git a/docs/src/main/asciidoc/appcds.adoc b/docs/src/main/asciidoc/appcds.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: core, cloud
 :summary: This reference guide explains how to enable AppCDS with Quarkus.
 :topics: appcds,serverless
-:extensions: io.quarkus:quarkus-core
 
 This reference guide explains how to enable Application Class Data Sharing in your Quarkus applications.
 

diff --git a/docs/src/main/asciidoc/build-analytics.adoc b/docs/src/main/asciidoc/build-analytics.adoc
@@ -6,7 +6,6 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 = Build analytics
 :categories: analytics
 :summary: This guide presents what build analytics is and how to configure it.
-:extensions: io.quarkus:quarkus-core
 
 The Quarkus team has limited knowledge, from Maven download numbers, of the remarkable growth of Quarkus and the number of users reporting issues/concerns. Still, we need more insight into the platforms, operating system, Java combinations, and build tools our users employ.
 The build analytics tool aims to provide us with this information.

diff --git a/docs/src/main/asciidoc/building-native-image.adoc b/docs/src/main/asciidoc/building-native-image.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: getting-started, native
 :summary: Build native executables with GraalVM or Mandrel.
 :topics: native,graalvm,mandrel
-:extensions: io.quarkus:quarkus-core
 
 This guide covers:
 

diff --git a/docs/src/main/asciidoc/capabilities.adoc b/docs/src/main/asciidoc/capabilities.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: writing-extensions
 :summary: How capabilities are implemented and used in Quarkus.
 :topics: extensions
-:extensions: io.quarkus:quarkus-core
 
 Quarkus extensions may provide certain capabilities and require certain capabilities to be provided by other extensions in an application to function properly.
 

diff --git a/docs/src/main/asciidoc/class-loading-reference.adoc b/docs/src/main/asciidoc/class-loading-reference.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: architecture
 :summary: Learn more about Quarkus class loading infrastructure.
 :topics: internals,extensions
-:extensions: io.quarkus:quarkus-core
 
 This document explains the Quarkus class loading architecture. It is intended for extension
 authors and advanced users who want to understand exactly how Quarkus works.

diff --git a/docs/src/main/asciidoc/command-mode-reference.adoc b/docs/src/main/asciidoc/command-mode-reference.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: core, command-line
 :summary: This reference guide explains how to develop command line applications with Quarkus.
 :topics: command-line,cli
-:extensions: io.quarkus:quarkus-core
 
 This reference covers how to write applications that run and then exit.
 

diff --git a/docs/src/main/asciidoc/conditional-extension-dependencies.adoc b/docs/src/main/asciidoc/conditional-extension-dependencies.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: writing-extensions
 :summary: Trigger the inclusion on additional extensions based on certain conditions.
 :topics: extensions
-:extensions: io.quarkus:quarkus-core
 
 Quarkus extension dependencies are usually configured in the same way as any other project dependencies in the project's build file, e.g. the Maven `pom.xml` or the Gradle build scripts. However, there are dependency types that aren't yet supported out-of-the-box by Maven and Gradle. What we refer here to as "conditional dependencies" is one example.
 

diff --git a/docs/src/main/asciidoc/config-extending-support.adoc b/docs/src/main/asciidoc/config-extending-support.adoc
@@ -11,7 +11,6 @@ include::_attributes.adoc[]
 :sectnums:
 :sectnumlevels: 4
 :topics: configuration
-:extensions: io.quarkus:quarkus-core
 
 [[custom-config-source]]
 == Custom `ConfigSource`

diff --git a/docs/src/main/asciidoc/config-mappings.adoc b/docs/src/main/asciidoc/config-mappings.adoc
@@ -11,7 +11,6 @@ include::_attributes.adoc[]
 :sectnums:
 :sectnumlevels: 4
 :topics: configuration
-:extensions: io.quarkus:quarkus-core
 
 With config mappings it is possible to group multiple configuration properties in a single interface that
 share the same prefix.

diff --git a/docs/src/main/asciidoc/config-reference.adoc b/docs/src/main/asciidoc/config-reference.adoc
@@ -11,7 +11,6 @@ include::_attributes.adoc[]
 :sectnums:
 :sectnumlevels: 4
 :topics: configuration
-:extensions: io.quarkus:quarkus-core
 
 IMPORTANT: The content of this guide has been revised and split into additional topics. Please check the <<additional-information,Additional Information>> section.
 

diff --git a/docs/src/main/asciidoc/config.adoc b/docs/src/main/asciidoc/config.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: core
 :summary: Hardcoded values in your code is a no go (even if we all did it at some point ;-)). In this guide, we learn how to configure your application.
 :topics: configuration
-:extensions: io.quarkus:quarkus-core
 
 IMPORTANT: The content of this guide and been revised and split into additional topics. Please check the
 <<additional-information,Additional Information>> section.

diff --git a/docs/src/main/asciidoc/context-propagation.adoc b/docs/src/main/asciidoc/context-propagation.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: core
 :summary: Learn more about how you can pass contextual information with SmallRye Context Propagation.
 :topics: context-propagation
-:extensions: io.quarkus:quarkus-core
 
 Traditional blocking code uses link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ThreadLocal.html[`ThreadLocal`]
  variables to store contextual objects in order to avoid

diff --git a/docs/src/main/asciidoc/continuous-testing.adoc b/docs/src/main/asciidoc/continuous-testing.adoc
@@ -10,8 +10,7 @@ include::_attributes.adoc[]
 :numbered:
 :sectnums:
 :sectnumlevels: 4
-:topics: testing,dev-ui,tooling,devmode
-:extensions: io.quarkus:quarkus-core
+:topics: testing,dev-ui,tooling,dev-mode
 
 Learn how to use continuous testing in your Quarkus Application.
 

diff --git a/docs/src/main/asciidoc/databases-dev-services.adoc b/docs/src/main/asciidoc/databases-dev-services.adoc
@@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 = Dev Services for Databases
 :categories: data, tooling
 include::_attributes.adoc[]
-:topics: devservices,data,database,datasource,tooling,testing,devmode
+:topics: dev-services,data,database,datasource,dev-mode,testing
 :extensions: io.quarkus:quarkus-agroal,io.quarkus:quarkus-reactive-mysql-client,io.quarkus:quarkus-reactive-oracle-client,io.quarkus:quarkus-reactive-pg-client,io.quarkus:quarkus-jdbc-db2,io.quarkus:quarkus-jdbc-derby,io.quarkus:quarkus-jdbc-h2,io.quarkus:quarkus-jdbc-mariadb,io.quarkus:quarkus-jdbc-mssql,io.quarkus:quarkus-jdbc-mysql,io.quarkus:quarkus-jdbc-oracle,io.quarkus:quarkus-jdbc-postgresql
 
 When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services.

diff --git a/docs/src/main/asciidoc/dev-mode-differences.adoc b/docs/src/main/asciidoc/dev-mode-differences.adoc
@@ -7,8 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: architecture
 :summary: How dev mode differs from a production application
-:topics: internals,devmode
-:extensions: io.quarkus:quarkus-core
+:topics: internals,dev-mode
 
 This document explains how the dev mode in Quarkus differs from a production application.
 

diff --git a/docs/src/main/asciidoc/dev-services.adoc b/docs/src/main/asciidoc/dev-services.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: core
 :summary: A list of all extensions that support Dev Services and their configuration options.
-:topics: devservices,tooling,testing,devmode
+:topics: dev-services,dev-mode,testing
 
 Quarkus supports the automatic provisioning of unconfigured services in development and test mode. We refer to this capability
 as Dev Services. From a developer's perspective this means that if you include an extension and don't configure it then

diff --git a/docs/src/main/asciidoc/dev-ui.adoc b/docs/src/main/asciidoc/dev-ui.adoc
@@ -7,8 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: writing-extensions
 :summary: Learn how to get your extension to contribute features to the Dev UI (v2).
-:topics: dev-ui,tooling,testing
-:extensions: io.quarkus:quarkus-core
+:topics: dev-ui,testing
 
 [NOTE]
 .Dev UI v2

diff --git a/docs/src/main/asciidoc/elasticsearch-dev-services.adoc b/docs/src/main/asciidoc/elasticsearch-dev-services.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: data
 :summary: Start Elasticsearch automatically in dev and test modes
-:topics: data,search,elasticsearch,nosql,devservices,tooling,testing,devmode
+:topics: data,search,elasticsearch,nosql,dev-services,testing,dev-mode
 :extensions: io.quarkus:quarkus-elasticsearch-java-client,io.quarkus:quarkus-elasticsearch-rest-client,io.quarkus:quarkus-hibernate-search-orm-elasticsearch
 
 If any Elasticsearch-related extension is present (e.g. `quarkus-elasticsearch-rest-client` or `quarkus-hibernate-search-orm-elasticsearch`),

diff --git a/docs/src/main/asciidoc/extension-codestart.adoc b/docs/src/main/asciidoc/extension-codestart.adoc
@@ -8,7 +8,6 @@ include::_attributes.adoc[]
 :categories: writing-extensions
 :summary: Provide users with initial code for extensions when generating Quarkus applications on code.quarkus.io and all the Quarkus tooling. This guide explains how to create and configure a Codestart for an extension.
 :topics: extensions,codestarts
-:extensions: io.quarkus:quarkus-core
 
 This guide explains how to create and configure a Quarkus Codestart for an extension.
 

diff --git a/docs/src/main/asciidoc/extension-metadata.adoc b/docs/src/main/asciidoc/extension-metadata.adoc
@@ -7,7 +7,6 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: writing-extensions
 :topics: extensions,codestarts
-:extensions: io.quarkus:quarkus-core
 
 Quarkus extensions are distributed as Maven JAR artifacts that application and other libraries may depend on. When a Quarkus application project is built, tested or edited using the Quarkus dev tools, Quarkus extension JAR artifacts will be identified on the application classpath by the presence of the Quarkus extension metadata files in them.
 This document describes the purpose of each Quarkus extension metadata file and its content.

diff --git a/docs/src/main/asciidoc/getting-started-dev-services.adoc b/docs/src/main/asciidoc/getting-started-dev-services.adoc
@@ -9,7 +9,7 @@ include::_attributes.adoc[]
 :diataxis-type: tutorial
 :categories: getting-started, data, core
 :summary: Discover some of the features that make developing with Quarkus a joyful experience.
-:topics: getting-started,devservices
+:topics: getting-started,dev-services
 
 This tutorial shows you how to create an application which writes to and reads from a database.
 You will use Dev Services, so you will not actually download, configure, or even start the database yourself.

diff --git a/docs/src/main/asciidoc/infinispan-dev-services.adoc b/docs/src/main/asciidoc/infinispan-dev-services.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: data
 :summary: Start Infinispan automatically in dev and test modes.
-:topics: devservices,data,infinispan,tooling,testing,devmode
+:topics: dev-services,data,infinispan,testing,dev-mode
 :extensions: io.quarkus:quarkus-infinispan-client
 
 Quarkus supports a feature called Dev Services that allows you to create various datasources without any config.

diff --git a/docs/src/main/asciidoc/kafka-dev-services.adoc b/docs/src/main/asciidoc/kafka-dev-services.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: messaging
 :summary: Start Apache Kafka automatically in dev and test modes.
-:topics: messaging,kafka,devservices,tooling,testing,devmode
+:topics: messaging,kafka,dev-services,testing,dev-mode
 :extensions: io.quarkus:quarkus-kafka-client,io.quarkus:quarkus-smallrye-reactive-messaging-kafka
 
 If any Kafka-related extension is present (e.g. `quarkus-smallrye-reactive-messaging-kafka`), Dev Services for Kafka automatically starts a Kafka broker in dev mode and when running tests.

diff --git a/docs/src/main/asciidoc/kafka-dev-ui.adoc b/docs/src/main/asciidoc/kafka-dev-ui.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: messaging
 :summary: Dev UI extension for Apache Kafka for development purposes.
-:topics: messaging,kafka,dev-ui,devmode
+:topics: messaging,kafka,dev-ui,dev-mode
 :extensions: io.quarkus:quarkus-kafka-client,io.quarkus:quarkus-smallrye-reactive-messaging-kafka
 
 If any Kafka-related extension is present (e.g. `quarkus-smallrye-reactive-messaging-kafka`),

diff --git a/docs/src/main/asciidoc/kubernetes-dev-services.adoc b/docs/src/main/asciidoc/kubernetes-dev-services.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: cloud
 :summary: Start a Kubernetes API server automatically in dev and test modes.
-:topics: devservices,kubernetes,tooling,testing,devmode
+:topics: dev-services,kubernetes,testing,dev-mode
 :extensions: io.quarkus:quarkus-kubernetes-client
 
 Dev Services for Kubernetes automatically starts a Kubernetes API server in dev mode and when running tests.

diff --git a/docs/src/main/asciidoc/lifecycle.adoc b/docs/src/main/asciidoc/lifecycle.adoc
@@ -9,7 +9,7 @@ include::_attributes.adoc[]
 :keywords: lifecycle event
 :summary: You often need to execute custom actions when the application starts and clean up everything when the application stops. This guide explains how to be notified when an application stops or starts.
 :topics: lifecycle,observers
-:extensions: io.quarkus:quarkus-core,io.quarkus:quarkus-arc
+:extensions: io.quarkus:quarkus-arc
 
 You often need to execute custom actions when the application starts and clean up everything when the application stops.
 This guide explains how to:

diff --git a/docs/src/main/asciidoc/logging.adoc b/docs/src/main/asciidoc/logging.adoc
@@ -9,7 +9,6 @@ include::_attributes.adoc[]
 :categories: core,getting-started,observability
 :diataxis-type: reference
 :topics: logging,observability
-:extensions: io.quarkus:quarkus-core
 
 Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs.
 

diff --git a/docs/src/main/asciidoc/pulsar-dev-services.adoc b/docs/src/main/asciidoc/pulsar-dev-services.adoc
@@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 = Dev Services for Pulsar
 include::_attributes.adoc[]
 :categories: messaging
-:topics: messaging,reactive-messaging,pulsar,devservices,tooling,testing,devmode
+:topics: messaging,reactive-messaging,pulsar,dev-services,testing,dev-mode
 :extensions: io.quarkus:quarkus-smallrye-reactive-messaging-pulsar
 
 With Quarkus Smallrye Reactive Messaging Pulsar extension (`quarkus-smallrye-reactive-messaging-pulsar`)

diff --git a/docs/src/main/asciidoc/rabbitmq-dev-services.adoc b/docs/src/main/asciidoc/rabbitmq-dev-services.adoc
@@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 = Dev Services for RabbitMQ
 include::_attributes.adoc[]
 :categories: messaging
-:topics: messaging,reactive-messaging,rabbitmq,devservices,tooling,testing,devmode
+:topics: messaging,reactive-messaging,rabbitmq,dev-services,testing,dev-mode
 :extensions: io.quarkus:quarkus-smallrye-reactive-messaging-rabbitmq
 
 Dev Services for RabbitMQ automatically starts a RabbitMQ broker in dev mode and when running tests.

diff --git a/docs/src/main/asciidoc/rabbitmq-reference.adoc b/docs/src/main/asciidoc/rabbitmq-reference.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :extension-status: preview
 :categories: messaging
-:topics: messaging,reactive-messaging,rabbitmq,devservices,tooling,testing,devmode
+:topics: messaging,reactive-messaging,rabbitmq,dev-services,testing,dev-mode
 :extensions: io.quarkus:quarkus-smallrye-reactive-messaging-rabbitmq
 
 This guide is the companion from the xref:rabbitmq.adoc[Getting Started with RabbitMQ].

diff --git a/docs/src/main/asciidoc/rabbitmq.adoc b/docs/src/main/asciidoc/rabbitmq.adoc
@@ -7,7 +7,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 :extension-status: preview
 include::_attributes.adoc[]
 :categories: messaging
-:topics: messaging,reactive-messaging,rabbitmq,devservices,tooling,testing,devmode
+:topics: messaging,reactive-messaging,rabbitmq
 :extensions: io.quarkus:quarkus-smallrye-reactive-messaging-rabbitmq
 
 This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with RabbitMQ.

diff --git a/docs/src/main/asciidoc/redis-dev-services.adoc b/docs/src/main/asciidoc/redis-dev-services.adoc
@@ -8,7 +8,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 include::_attributes.adoc[]
 :categories: data
 :summary: Start Redis automatically in dev and test modes.
-:topics: data,redis,nosql,devservices,tooling,testing,devmode
+:topics: data,redis,nosql,dev-services,testing,dev-mode
 :extensions: io.quarkus:quarkus-redis-client
 
 Quarkus supports a feature called Dev Services that allows you to create various datasources without any config.

diff --git a/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc b/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc
@@ -8,7 +8,7 @@ include::_attributes.adoc[]
 :categories: security
 :keywords: sso oidc security keycloak
 :summary: Start Keycloak or other providers automatically in dev and test modes.
-:topics: security,oidc,keycloak,devservices,tooling,testing,devmode
+:topics: security,oidc,keycloak,dev-services,testing,dev-mode
 :extensions: io.quarkus:quarkus-oidc
 
 This guide covers the Dev Services and UI for OpenID Connect (OIDC) Keycloak provider and explains how to support Dev Services and UI for other OpenID Connect providers.

diff --git a/docs/src/main/asciidoc/virtual-threads.adoc b/docs/src/main/asciidoc/virtual-threads.adoc
@@ -15,7 +15,6 @@ include::_attributes.adoc[]
 :thread: https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Thread.html
 :pgsql-driver: https://javadoc.io/doc/org.postgresql/postgresql/latest/index.html
 :topics: virtual-threads
-:extensions: io.quarkus:quarkus-core
 
 This guide explains how to benefit from Java 21+ virtual threads in Quarkus application.