From 0bfb83f74d3108e56f52dd5503719568f65db4e4 Mon Sep 17 00:00:00 2001 From: Nathan Erwin Date: Tue, 11 Oct 2022 21:33:41 -0400 Subject: [PATCH] Added category and summary metadata to documentation files Signed-off-by:Nathan Erwin --- docs/src/main/asciidoc/all-builditems.adoc | 5 +++-- docs/src/main/asciidoc/all-config.adoc | 3 ++- docs/src/main/asciidoc/amazon-lambda-http.adoc | 3 ++- docs/src/main/asciidoc/amazon-lambda.adoc | 3 ++- docs/src/main/asciidoc/amqp-dev-services.adoc | 3 ++- docs/src/main/asciidoc/amqp.adoc | 3 ++- docs/src/main/asciidoc/apicurio-registry-dev-services.adoc | 3 ++- docs/src/main/asciidoc/azure-functions-http.adoc | 3 ++- docs/src/main/asciidoc/blaze-persistence.adoc | 3 ++- docs/src/main/asciidoc/building-my-first-extension.adoc | 3 ++- docs/src/main/asciidoc/building-native-image.adoc | 3 ++- docs/src/main/asciidoc/cache.adoc | 3 ++- docs/src/main/asciidoc/camel.adoc | 3 ++- docs/src/main/asciidoc/capabilities.adoc | 3 ++- docs/src/main/asciidoc/cassandra.adoc | 3 ++- docs/src/main/asciidoc/cdi-integration.adoc | 3 ++- docs/src/main/asciidoc/cdi-reference.adoc | 3 ++- docs/src/main/asciidoc/cdi.adoc | 3 ++- docs/src/main/asciidoc/centralized-log-management.adoc | 3 ++- docs/src/main/asciidoc/class-loading-reference.adoc | 3 ++- docs/src/main/asciidoc/cli-tooling.adoc | 3 ++- docs/src/main/asciidoc/command-mode-reference.adoc | 3 ++- .../main/asciidoc/conditional-extension-dependencies.adoc | 3 ++- docs/src/main/asciidoc/config-extending-support.adoc | 4 ++-- docs/src/main/asciidoc/config-mappings.adoc | 6 +++--- docs/src/main/asciidoc/config-reference.adoc | 4 ++-- docs/src/main/asciidoc/config-yaml.adoc | 4 ++-- docs/src/main/asciidoc/config.adoc | 3 ++- docs/src/main/asciidoc/container-image.adoc | 3 ++- docs/src/main/asciidoc/context-propagation.adoc | 3 ++- docs/src/main/asciidoc/continuous-testing.adoc | 4 ++-- docs/src/main/asciidoc/credentials-provider.adoc | 3 ++- docs/src/main/asciidoc/datasource.adoc | 3 ++- docs/src/main/asciidoc/deploying-to-azure-cloud.adoc | 3 ++- docs/src/main/asciidoc/deploying-to-google-cloud.adoc | 3 ++- docs/src/main/asciidoc/deploying-to-heroku.adoc | 2 ++ docs/src/main/asciidoc/deploying-to-kubernetes.adoc | 3 ++- docs/src/main/asciidoc/deploying-to-openshift.adoc | 3 ++- docs/src/main/asciidoc/dev-mode-differences.adoc | 3 ++- docs/src/main/asciidoc/dev-services.adoc | 3 ++- docs/src/main/asciidoc/dev-ui.adoc | 3 ++- docs/src/main/asciidoc/elasticsearch.adoc | 2 ++ docs/src/main/asciidoc/extension-codestart.adoc | 2 ++ docs/src/main/asciidoc/extension-registry-user.adoc | 3 ++- docs/src/main/asciidoc/flyway.adoc | 3 ++- docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc | 3 ++- docs/src/main/asciidoc/funqy-amazon-lambda.adoc | 3 ++- docs/src/main/asciidoc/funqy-azure-functions-http.adoc | 3 ++- docs/src/main/asciidoc/funqy-gcp-functions-http.adoc | 3 ++- docs/src/main/asciidoc/funqy-gcp-functions.adoc | 3 ++- docs/src/main/asciidoc/funqy-http.adoc | 3 ++- docs/src/main/asciidoc/funqy-knative-events.adoc | 3 ++- docs/src/main/asciidoc/funqy.adoc | 3 ++- docs/src/main/asciidoc/gcp-functions-http.adoc | 3 ++- docs/src/main/asciidoc/gcp-functions.adoc | 3 ++- docs/src/main/asciidoc/getting-started-reactive.adoc | 3 ++- docs/src/main/asciidoc/getting-started-testing.adoc | 4 ++-- docs/src/main/asciidoc/getting-started.adoc | 2 ++ docs/src/main/asciidoc/gradle-tooling.adoc | 3 ++- docs/src/main/asciidoc/grpc-getting-started.adoc | 3 ++- docs/src/main/asciidoc/grpc-service-consumption.adoc | 3 ++- docs/src/main/asciidoc/grpc-service-implementation.adoc | 3 ++- docs/src/main/asciidoc/grpc.adoc | 3 ++- docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc | 3 ++- docs/src/main/asciidoc/hibernate-orm-panache.adoc | 3 ++- docs/src/main/asciidoc/hibernate-orm.adoc | 3 ++- docs/src/main/asciidoc/hibernate-reactive-panache.adoc | 3 ++- .../main/asciidoc/hibernate-search-orm-elasticsearch.adoc | 2 ++ docs/src/main/asciidoc/http-reference.adoc | 3 ++- docs/src/main/asciidoc/ide-tooling.adoc | 3 ++- docs/src/main/asciidoc/infinispan-client.adoc | 3 ++- docs/src/main/asciidoc/jms.adoc | 2 ++ docs/src/main/asciidoc/kafka-dev-services.adoc | 3 ++- docs/src/main/asciidoc/kafka-reactive-getting-started.adoc | 3 ++- docs/src/main/asciidoc/kafka-schema-registry-avro.adoc | 3 ++- docs/src/main/asciidoc/kafka-streams.adoc | 3 ++- docs/src/main/asciidoc/kafka.adoc | 4 ++-- docs/src/main/asciidoc/kogito-dmn.adoc | 3 ++- docs/src/main/asciidoc/kogito-drl.adoc | 3 ++- docs/src/main/asciidoc/kogito-pmml.adoc | 3 ++- docs/src/main/asciidoc/kogito.adoc | 3 ++- docs/src/main/asciidoc/kotlin.adoc | 3 ++- docs/src/main/asciidoc/kubernetes-client.adoc | 3 ++- docs/src/main/asciidoc/kubernetes-config.adoc | 3 ++- docs/src/main/asciidoc/lifecycle.adoc | 3 ++- docs/src/main/asciidoc/liquibase.adoc | 3 ++- docs/src/main/asciidoc/logging.adoc | 3 ++- docs/src/main/asciidoc/lra.adoc | 3 ++- docs/src/main/asciidoc/mailer-reference.adoc | 3 ++- docs/src/main/asciidoc/mailer.adoc | 3 ++- docs/src/main/asciidoc/maven-tooling.adoc | 3 ++- docs/src/main/asciidoc/micrometer.adoc | 3 ++- docs/src/main/asciidoc/mongodb-panache-kotlin.adoc | 3 ++- docs/src/main/asciidoc/mongodb-panache.adoc | 3 ++- docs/src/main/asciidoc/mongodb.adoc | 2 ++ docs/src/main/asciidoc/native-and-ssl.adoc | 3 ++- docs/src/main/asciidoc/openapi-swaggerui.adoc | 3 ++- docs/src/main/asciidoc/opentelemetry.adoc | 3 ++- docs/src/main/asciidoc/opentracing.adoc | 3 ++- docs/src/main/asciidoc/optaplanner.adoc | 3 ++- docs/src/main/asciidoc/performance-measure.adoc | 3 ++- docs/src/main/asciidoc/picocli.adoc | 3 ++- docs/src/main/asciidoc/platform.adoc | 3 ++- docs/src/main/asciidoc/quarkus-reactive-architecture.adoc | 3 ++- docs/src/main/asciidoc/quartz.adoc | 3 ++- docs/src/main/asciidoc/qute-reference.adoc | 4 ++-- docs/src/main/asciidoc/qute.adoc | 3 ++- docs/src/main/asciidoc/reactive-event-bus.adoc | 3 ++- docs/src/main/asciidoc/reactive-routes.adoc | 3 ++- docs/src/main/asciidoc/reactive-sql-clients.adoc | 3 ++- docs/src/main/asciidoc/reaugmentation.adoc | 3 ++- docs/src/main/asciidoc/redis-dev-services.adoc | 3 ++- docs/src/main/asciidoc/redis.adoc | 2 ++ docs/src/main/asciidoc/rest-client-multipart.adoc | 3 ++- docs/src/main/asciidoc/rest-client-reactive.adoc | 3 ++- docs/src/main/asciidoc/rest-client.adoc | 3 ++- docs/src/main/asciidoc/rest-data-panache.adoc | 3 ++- docs/src/main/asciidoc/rest-json.adoc | 3 ++- docs/src/main/asciidoc/resteasy-reactive.adoc | 3 ++- docs/src/main/asciidoc/scheduler-reference.adoc | 4 ++-- docs/src/main/asciidoc/scheduler.adoc | 3 ++- docs/src/main/asciidoc/scripting.adoc | 2 ++ docs/src/main/asciidoc/security-jdbc.adoc | 3 ++- docs/src/main/asciidoc/security-jwt.adoc | 3 ++- docs/src/main/asciidoc/security-keycloak-authorization.adoc | 3 ++- docs/src/main/asciidoc/security-ldap.adoc | 3 ++- docs/src/main/asciidoc/security-oauth2.adoc | 3 ++- docs/src/main/asciidoc/security-openid-connect-client.adoc | 3 ++- .../main/asciidoc/security-openid-connect-dev-services.adoc | 3 ++- .../main/asciidoc/security-openid-connect-multitenancy.adoc | 3 ++- .../security-openid-connect-web-authentication.adoc | 2 ++ docs/src/main/asciidoc/security-openid-connect.adoc | 3 ++- docs/src/main/asciidoc/security-properties.adoc | 3 ++- docs/src/main/asciidoc/security.adoc | 3 ++- docs/src/main/asciidoc/smallrye-fault-tolerance.adoc | 3 ++- docs/src/main/asciidoc/smallrye-graphql-client.adoc | 3 ++- docs/src/main/asciidoc/smallrye-graphql.adoc | 3 ++- docs/src/main/asciidoc/smallrye-health.adoc | 3 ++- docs/src/main/asciidoc/smallrye-metrics.adoc | 3 ++- docs/src/main/asciidoc/software-transactional-memory.adoc | 3 ++- docs/src/main/asciidoc/spring-boot-properties.adoc | 3 ++- docs/src/main/asciidoc/spring-cache.adoc | 3 ++- docs/src/main/asciidoc/spring-cloud-config-client.adoc | 3 ++- docs/src/main/asciidoc/spring-data-jpa.adoc | 3 ++- docs/src/main/asciidoc/spring-data-rest.adoc | 3 ++- docs/src/main/asciidoc/spring-di.adoc | 3 ++- docs/src/main/asciidoc/spring-scheduled.adoc | 3 ++- docs/src/main/asciidoc/spring-security.adoc | 3 ++- docs/src/main/asciidoc/spring-web.adoc | 3 ++- docs/src/main/asciidoc/tests-with-coverage.adoc | 4 ++-- docs/src/main/asciidoc/tooling.adoc | 3 ++- docs/src/main/asciidoc/transaction.adoc | 3 ++- docs/src/main/asciidoc/validation.adoc | 3 ++- docs/src/main/asciidoc/vertx-reference.adoc | 3 ++- docs/src/main/asciidoc/vertx.adoc | 3 ++- docs/src/main/asciidoc/websockets.adoc | 3 ++- docs/src/main/asciidoc/writing-extensions.adoc | 3 ++- .../src/main/asciidoc/writing-native-applications-tips.adoc | 3 ++- 158 files changed, 318 insertions(+), 160 deletions(-) diff --git a/docs/src/main/asciidoc/all-builditems.adoc b/docs/src/main/asciidoc/all-builditems.adoc index 0b1a4dcdfb136..a409c1fe958d2 100644 --- a/docs/src/main/asciidoc/all-builditems.adoc +++ b/docs/src/main/asciidoc/all-builditems.adoc @@ -6,9 +6,10 @@ This guide is maintained in the main Quarkus repository and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// -include::./attributes.adoc[] - = Build Items +include::./attributes.adoc[] +:categories: writing-extensions +:summary: Explore all the BuildItems you can consume/produce in your extensions. Here you can find a list of Build Items and the extension that provides them: diff --git a/docs/src/main/asciidoc/all-config.adoc b/docs/src/main/asciidoc/all-config.adoc index b3230ceff0548..42c8b12f11336 100644 --- a/docs/src/main/asciidoc/all-config.adoc +++ b/docs/src/main/asciidoc/all-config.adoc @@ -7,7 +7,8 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = All configuration options - include::./attributes.adoc[] +:categories: core +:summary: List all the configuration properties per extensions include::{generated-dir}/config/quarkus-all-config.adoc[opts=optional] diff --git a/docs/src/main/asciidoc/amazon-lambda-http.adoc b/docs/src/main/asciidoc/amazon-lambda-http.adoc index 209e9ab96b90f..81c2d3e55dae5 100644 --- a/docs/src/main/asciidoc/amazon-lambda-http.adoc +++ b/docs/src/main/asciidoc/amazon-lambda-http.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Amazon Lambda with RESTEasy Reactive, Undertow, or Reactive Routes :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an Amazon Lambda. :devtools-no-gradle: With Quarkus you can deploy your favorite Java HTTP frameworks as Amazon Lambda's using either the https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html[AWS Gateway HTTP API] diff --git a/docs/src/main/asciidoc/amazon-lambda.adoc b/docs/src/main/asciidoc/amazon-lambda.adoc index 61c85e39dbf80..67fb33b5a5c31 100644 --- a/docs/src/main/asciidoc/amazon-lambda.adoc +++ b/docs/src/main/asciidoc/amazon-lambda.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Amazon Lambda - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains how you can deploy Quarkus-based Amazon Lambdas. The `quarkus-amazon-lambda` extension allows you to use Quarkus to build your AWS Lambdas. Your lambdas can use injection annotations from CDI or Spring and other Quarkus facilities as you need them. diff --git a/docs/src/main/asciidoc/amqp-dev-services.adoc b/docs/src/main/asciidoc/amqp-dev-services.adoc index 72c11b83be283..34b884f3160e4 100644 --- a/docs/src/main/asciidoc/amqp-dev-services.adoc +++ b/docs/src/main/asciidoc/amqp-dev-services.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for AMQP - include::./attributes.adoc[] +:categories: messaging +:summary: Start AMQP automatically in dev and test modes. 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/amqp.adoc b/docs/src/main/asciidoc/amqp.adoc index 1e7491628b64e..a692acf53db49 100644 --- a/docs/src/main/asciidoc/amqp.adoc +++ b/docs/src/main/asciidoc/amqp.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Getting Started to SmallRye Reactive Messaging with AMQP 1.0 - include::./attributes.adoc[] +:categories: messaging +:summary: This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with AMQP. This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with AMQP 1.0. diff --git a/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc b/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc index 622eb57274586..7ca82d5031d27 100644 --- a/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc +++ b/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for Apicurio Registry - include::./attributes.adoc[] +:categories: messaging +:summary: Start Apicurio Registry automatically in dev and test modes. 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. Also, all Kafka channels in SmallRye Reactive Messaging are automatically configured to use this registry. diff --git a/docs/src/main/asciidoc/azure-functions-http.adoc b/docs/src/main/asciidoc/azure-functions-http.adoc index d6973466c4a92..3744f2748f9b7 100644 --- a/docs/src/main/asciidoc/azure-functions-http.adoc +++ b/docs/src/main/asciidoc/azure-functions-http.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Azure Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an Azure Function. The `quarkus-azure-functions-http` extension allows you to write microservices with RESTEasy Reactive (JAX-RS), Undertow (servlet), Reactive Routes, or xref:funqy-http.adoc[Funqy HTTP] and make these microservices deployable to the Azure Functions runtime. diff --git a/docs/src/main/asciidoc/blaze-persistence.adoc b/docs/src/main/asciidoc/blaze-persistence.adoc index 9477bee95fa07..bcdd5f95f1538 100644 --- a/docs/src/main/asciidoc/blaze-persistence.adoc +++ b/docs/src/main/asciidoc/blaze-persistence.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Blaze-Persistence - include::./attributes.adoc[] +:categories: data +:summary: This guide explains how to use Blaze-Persistence to simplify your data and DTO layers. :config-file: application.properties Blaze-Persistence offers a fluent query builder API on top of JPA with a deep Hibernate ORM integration that enables the diff --git a/docs/src/main/asciidoc/building-my-first-extension.adoc b/docs/src/main/asciidoc/building-my-first-extension.adoc index 9829ffc162cf1..7b3dd527ff77c 100644 --- a/docs/src/main/asciidoc/building-my-first-extension.adoc +++ b/docs/src/main/asciidoc/building-my-first-extension.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Building my first extension - include::./attributes.adoc[] +:categories: writing-extensions +:summary: Learn step by step how to build a simple extension. Quarkus extensions enhance your application just as projects dependencies do. The role of the extensions is to leverage Quarkus paradigms to integrate seamlessly a library into Quarkus architecture - e.g. do more things at build time. diff --git a/docs/src/main/asciidoc/building-native-image.adoc b/docs/src/main/asciidoc/building-native-image.adoc index 6fe6cf210e089..41b1b2528ad2c 100644 --- a/docs/src/main/asciidoc/building-native-image.adoc +++ b/docs/src/main/asciidoc/building-native-image.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Building a Native Executable - include::./attributes.adoc[] +:categories: getting-started +:summary: Build native executables with GraalVM or Mandrel. This guide covers: diff --git a/docs/src/main/asciidoc/cache.adoc b/docs/src/main/asciidoc/cache.adoc index b28fa56723e63..e641a73975b1a 100644 --- a/docs/src/main/asciidoc/cache.adoc +++ b/docs/src/main/asciidoc/cache.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Application Data Caching :extension-status: preview - include::./attributes.adoc[] +:categories: data +:summary: This guide explains how to cache expensive method calls of your CDI beans using simple annotations. In this guide, you will learn how to enable application data caching in any CDI managed bean of your Quarkus application. diff --git a/docs/src/main/asciidoc/camel.adoc b/docs/src/main/asciidoc/camel.adoc index 25de8d023dea6..e038e23f52767 100644 --- a/docs/src/main/asciidoc/camel.adoc +++ b/docs/src/main/asciidoc/camel.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Apache Camel on Quarkus - include::./attributes.adoc[] +:categories: integration +:summary: This guide covers the systems integration with Apache Camel https://camel.apache.org/[Apache Camel] is the Swiss knife of integrating heterogeneous systems with more than a decade of history and a lively community of users and developers. diff --git a/docs/src/main/asciidoc/capabilities.adoc b/docs/src/main/asciidoc/capabilities.adoc index 78f48a9b8b8c4..251193021c59f 100644 --- a/docs/src/main/asciidoc/capabilities.adoc +++ b/docs/src/main/asciidoc/capabilities.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extension Capabilities - include::./attributes.adoc[] +:categories: writing-extensions +:summary: How capabilities are implemented and used in Quarkus. 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/cassandra.adoc b/docs/src/main/asciidoc/cassandra.adoc index af1fa26831642..0429e0e9e913c 100644 --- a/docs/src/main/asciidoc/cassandra.adoc +++ b/docs/src/main/asciidoc/cassandra.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the Cassandra Client - include::./attributes.adoc[] +:categories: data +:summary: This guide covers how to use the Apache Cassandra NoSQL database in Quarkus. Apache Cassandra® is a free and open-source, distributed, wide column store, NoSQL database management system designed to handle large amounts of data across many commodity servers, providing diff --git a/docs/src/main/asciidoc/cdi-integration.adoc b/docs/src/main/asciidoc/cdi-integration.adoc index 73cfe4d4fa845..65f4a7d693487 100644 --- a/docs/src/main/asciidoc/cdi-integration.adoc +++ b/docs/src/main/asciidoc/cdi-integration.adoc @@ -4,7 +4,8 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = CDI Integration Guide - +:categories: writing-extensions +:summary: Learn how to integrate your extension with Quarkus' CDI container. include::./attributes.adoc[] :numbered: :toc: diff --git a/docs/src/main/asciidoc/cdi-reference.adoc b/docs/src/main/asciidoc/cdi-reference.adoc index 43b67fae2490a..fb45c16f9c0ff 100644 --- a/docs/src/main/asciidoc/cdi-reference.adoc +++ b/docs/src/main/asciidoc/cdi-reference.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Contexts and Dependency Injection - include::./attributes.adoc[] +:categories: core +:summary: Go more in depth into the Quarkus implementation of CDI. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/cdi.adoc b/docs/src/main/asciidoc/cdi.adoc index 3b088a2716031..cb5ac76825050 100644 --- a/docs/src/main/asciidoc/cdi.adoc +++ b/docs/src/main/asciidoc/cdi.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Introduction to Contexts and Dependency Injection - include::./attributes.adoc[] +:categories: core +:summary: Quarkus DI solution is based on the [Contexts and Dependency Injection for Java 2.0](https://docs.jboss.org/cdi/spec/2.0/cdi-spec) specification. This guide explains the basics of CDI. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/centralized-log-management.adoc b/docs/src/main/asciidoc/centralized-log-management.adoc index 157b87a1eaeb6..1df8b71cf4658 100644 --- a/docs/src/main/asciidoc/centralized-log-management.adoc +++ b/docs/src/main/asciidoc/centralized-log-management.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Centralized log management (Graylog, Logstash, Fluentd) - include::./attributes.adoc[] +:categories: observability +:summary: This guide explains how to centralize your logs with Logstash or Fluentd using the Graylog Extended Log Format (GELF). This guide explains how you can send your logs to a centralized log management system like Graylog, Logstash (inside the Elastic Stack or ELK - Elasticsearch, Logstash, Kibana) or Fluentd (inside EFK - Elasticsearch, Fluentd, Kibana). diff --git a/docs/src/main/asciidoc/class-loading-reference.adoc b/docs/src/main/asciidoc/class-loading-reference.adoc index 7a8d552976f9a..3ba476a4912c6 100644 --- a/docs/src/main/asciidoc/class-loading-reference.adoc +++ b/docs/src/main/asciidoc/class-loading-reference.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Class Loading Reference - include::./attributes.adoc[] +:categories: architecture +:summary: Learn more about Quarkus class loading infrastructure. 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/cli-tooling.adoc b/docs/src/main/asciidoc/cli-tooling.adoc index 1ee99347e4167..43613cd54b276 100644 --- a/docs/src/main/asciidoc/cli-tooling.adoc +++ b/docs/src/main/asciidoc/cli-tooling.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Building Quarkus apps with Quarkus Command Line Interface (CLI) :extension-status: preview - include::./attributes.adoc[] +:categories: tooling +:summary: Use the Quarkus CLI to create, build, run, and manage extensions for Quarkus projects. The `quarkus` command lets you create projects, manage extensions and do essential build and dev commands using the underlying project build tool. diff --git a/docs/src/main/asciidoc/command-mode-reference.adoc b/docs/src/main/asciidoc/command-mode-reference.adoc index 89f0013fe373e..8d28d8c95fc56 100644 --- a/docs/src/main/asciidoc/command-mode-reference.adoc +++ b/docs/src/main/asciidoc/command-mode-reference.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Command Mode Applications - include::./attributes.adoc[] +:categories: core, command-line +:summary: This reference guide explains how to develop command line applications with Quarkus. 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 index 2fe24402dba75..226e8350f8c0c 100644 --- a/docs/src/main/asciidoc/conditional-extension-dependencies.adoc +++ b/docs/src/main/asciidoc/conditional-extension-dependencies.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Conditional Extension Dependencies - include::./attributes.adoc[] +:categories: writing-extensions +:summary: Trigger the inclusion on additional extensions based on certain conditions. 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 index f1c843711f51d..80eb149336b79 100644 --- a/docs/src/main/asciidoc/config-extending-support.adoc +++ b/docs/src/main/asciidoc/config-extending-support.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extending Configuration Support - include::./attributes.adoc[] - +:categories: core +:summary: Extend and customize the Configuration. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/config-mappings.adoc b/docs/src/main/asciidoc/config-mappings.adoc index 2884a9a1fff53..3fb379e1639aa 100644 --- a/docs/src/main/asciidoc/config-mappings.adoc +++ b/docs/src/main/asciidoc/config-mappings.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Mapping configuration to objects - include::./attributes.adoc[] - +:categories: core +:summary: Group multiple configuration properties into an object. :numbered: :sectnums: :sectnumlevels: 4 @@ -552,4 +552,4 @@ class AppConfigTest { } ---- -NOTE: Nested elements need to be spied individually by Mockito. \ No newline at end of file +NOTE: Nested elements need to be spied individually by Mockito. diff --git a/docs/src/main/asciidoc/config-reference.adoc b/docs/src/main/asciidoc/config-reference.adoc index d9c2319373319..615023c1d8341 100644 --- a/docs/src/main/asciidoc/config-reference.adoc +++ b/docs/src/main/asciidoc/config-reference.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Configuration Reference Guide - include::./attributes.adoc[] - +:categories: core +:summary: Learn more about how to configure your Quarkus applications. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/config-yaml.adoc b/docs/src/main/asciidoc/config-yaml.adoc index 5c95de026ee70..7265674064dcd 100644 --- a/docs/src/main/asciidoc/config-yaml.adoc +++ b/docs/src/main/asciidoc/config-yaml.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = YAML Configuration - include::./attributes.adoc[] - +:categories: core +:summary: YAML as a Configuration Source. :toc: https://en.wikipedia.org/wiki/YAML[YAML] is a very popular format. Kubernetes relies heavily on the YAML format to diff --git a/docs/src/main/asciidoc/config.adoc b/docs/src/main/asciidoc/config.adoc index cb617c0347b3a..9eed2c89e2fe8 100644 --- a/docs/src/main/asciidoc/config.adoc +++ b/docs/src/main/asciidoc/config.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Configuring Your Application - 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. IMPORTANT: The content of this guide and been revised and split into additional topics. Please check the <> section. diff --git a/docs/src/main/asciidoc/container-image.adoc b/docs/src/main/asciidoc/container-image.adoc index b523e13686810..cbfc15f7bde50 100644 --- a/docs/src/main/asciidoc/container-image.adoc +++ b/docs/src/main/asciidoc/container-image.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Container Images - include::./attributes.adoc[] +:categories: cloud +:summary: Learn how to build and push container images with Jib, S2I or Docker as part of the Quarkus build. Quarkus provides extensions for building (and pushing) container images. Currently, it supports: diff --git a/docs/src/main/asciidoc/context-propagation.adoc b/docs/src/main/asciidoc/context-propagation.adoc index 5a41c4acfc54d..29e02a72045ba 100644 --- a/docs/src/main/asciidoc/context-propagation.adoc +++ b/docs/src/main/asciidoc/context-propagation.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Context Propagation in Quarkus - include::./attributes.adoc[] +:categories: core +:summary: Learn more about how you can pass contextual information with SmallRye Context Propagation. 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 index fffc68709a456..17114e37744bd 100644 --- a/docs/src/main/asciidoc/continuous-testing.adoc +++ b/docs/src/main/asciidoc/continuous-testing.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Continuous Testing - include::./attributes.adoc[] - +:categories: core +:summary: Get early test feedback with Continuous Testing. :toc: macro :toclevels: 4 :doctype: book diff --git a/docs/src/main/asciidoc/credentials-provider.adoc b/docs/src/main/asciidoc/credentials-provider.adoc index 7137bf6520d16..d67dba88e8ca5 100644 --- a/docs/src/main/asciidoc/credentials-provider.adoc +++ b/docs/src/main/asciidoc/credentials-provider.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using a Credentials Provider - include::./attributes.adoc[] +:categories: security +:summary: This guides explains how to use the Vault credentials provider or implement your own custom one. :extension-status: preview Interacting with a datastore typically implies first connecting using credentials. diff --git a/docs/src/main/asciidoc/datasource.adoc b/docs/src/main/asciidoc/datasource.adoc index bc2eeb662c69c..ada6178d40b8f 100644 --- a/docs/src/main/asciidoc/datasource.adoc +++ b/docs/src/main/asciidoc/datasource.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Datasources - include::./attributes.adoc[] +:categories: data +:summary: With Quarkus, you can easily configure a datasource, or several if need be. Many projects that use data require connections to a relational database. diff --git a/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc b/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc index d21c335ca64b9..3396eee0e0f33 100644 --- a/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc +++ b/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Deploying to Microsoft Azure Cloud - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains how to deploy a Quarkus application to Microsoft Azure Cloud. This guide covers: diff --git a/docs/src/main/asciidoc/deploying-to-google-cloud.adoc b/docs/src/main/asciidoc/deploying-to-google-cloud.adoc index 3135e952502ef..ff5cb3bc86934 100644 --- a/docs/src/main/asciidoc/deploying-to-google-cloud.adoc +++ b/docs/src/main/asciidoc/deploying-to-google-cloud.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Deploying to Google Cloud Platform (GCP) - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains how to deploy a Quarkus application to Google Cloud. This guide covers: diff --git a/docs/src/main/asciidoc/deploying-to-heroku.adoc b/docs/src/main/asciidoc/deploying-to-heroku.adoc index f4f157b610240..ec518db2572f6 100644 --- a/docs/src/main/asciidoc/deploying-to-heroku.adoc +++ b/docs/src/main/asciidoc/deploying-to-heroku.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Deploying to Heroku include::./attributes.adoc[] +:categories: cloud +:summary: Deploy your Quarkus applications on Heroku. In this guide you will learn how to deploy a Quarkus based web application as a web-dyno to Heroku. diff --git a/docs/src/main/asciidoc/deploying-to-kubernetes.adoc b/docs/src/main/asciidoc/deploying-to-kubernetes.adoc index b3fb6c0744db9..8e435d4815b49 100644 --- a/docs/src/main/asciidoc/deploying-to-kubernetes.adoc +++ b/docs/src/main/asciidoc/deploying-to-kubernetes.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Kubernetes extension - include::./attributes.adoc[] +:categories: cloud +:summary: This guide covers how to deploy a native application on Kubernetes. Quarkus offers the ability to automatically generate Kubernetes resources based on sane defaults and user-supplied configuration using https://github.com/dekorateio/dekorate/[dekorate]. It currently supports generating resources for vanilla <<#kubernetes,Kubernetes>>, <<#openshift,OpenShift>> and <<#knative,Knative>>. diff --git a/docs/src/main/asciidoc/deploying-to-openshift.adoc b/docs/src/main/asciidoc/deploying-to-openshift.adoc index acaf50a233a09..d37adbc4b7cf6 100644 --- a/docs/src/main/asciidoc/deploying-to-openshift.adoc +++ b/docs/src/main/asciidoc/deploying-to-openshift.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Deploying on OpenShift - include::./attributes.adoc[] +:categories: cloud +:summary: This guide covers how to deploy a native application on OpenShift. This guide covers generating and deploying OpenShift resources based on sane default and user supplied configuration. diff --git a/docs/src/main/asciidoc/dev-mode-differences.adoc b/docs/src/main/asciidoc/dev-mode-differences.adoc index a1b479f08134b..a88ddc2e23f63 100644 --- a/docs/src/main/asciidoc/dev-mode-differences.adoc +++ b/docs/src/main/asciidoc/dev-mode-differences.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = How dev mode differs from a production application - include::./attributes.adoc[] +:categories: architecture +:summary: How dev mode differs from a production application 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 index 2a19404aaa061..14a166637e7db 100644 --- a/docs/src/main/asciidoc/dev-services.adoc +++ b/docs/src/main/asciidoc/dev-services.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services Overview - include::./attributes.adoc[] +:categories: core +:summary: A list of all extensions that support Dev Services and their configuration options. 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 index 9751ef4ffec3c..479df7124b6fd 100644 --- a/docs/src/main/asciidoc/dev-ui.adoc +++ b/docs/src/main/asciidoc/dev-ui.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev UI - include::./attributes.adoc[] +:categories: writing-extensions +:summary: Learn how to get your extension contribute features to the Dev UI. This guide covers the Quarkus Dev UI for xref:building-my-first-extension.adoc[extension authors]. diff --git a/docs/src/main/asciidoc/elasticsearch.adoc b/docs/src/main/asciidoc/elasticsearch.adoc index fd4633ed611f4..5225db7ea0246 100644 --- a/docs/src/main/asciidoc/elasticsearch.adoc +++ b/docs/src/main/asciidoc/elasticsearch.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Connecting to an Elasticsearch cluster include::./attributes.adoc[] +:categories: data +:summary: This guide covers how to use an Elasticsearch cluster using the low level or high level REST clients. Elasticsearch is a well known full text search engine and NoSQL datastore. diff --git a/docs/src/main/asciidoc/extension-codestart.adoc b/docs/src/main/asciidoc/extension-codestart.adoc index 108912f1223f4..22194aeb1ebf2 100644 --- a/docs/src/main/asciidoc/extension-codestart.adoc +++ b/docs/src/main/asciidoc/extension-codestart.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extension codestart 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. This guide explains how to create and configure a Quarkus Codestart for an extension. diff --git a/docs/src/main/asciidoc/extension-registry-user.adoc b/docs/src/main/asciidoc/extension-registry-user.adoc index bbbb3e39e11f7..7496fe05057d1 100644 --- a/docs/src/main/asciidoc/extension-registry-user.adoc +++ b/docs/src/main/asciidoc/extension-registry-user.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension Registry - include::./attributes.adoc[] +:categories: architecture +:summary: Learn more about the notion of extension registry and how you can use your own. The Quarkus dev tools, such as the https://quarkus.io/guides/cli-tooling[Quarkus CLI], the https://quarkus.io/guides/maven-tooling[Maven] and the https://quarkus.io/guides/gradle-tooling[Gradle] plugins, or https://code.quarkus.io[code.quarkus.io] can be used to list and search the Quarkus ecosystem for extensions that match a certain criteria. That includes the https://quarkus.io/guides/platform[Quarkus platform] extensions and various other extensions contributed by the community, many of which are hosted on the https://github.com/quarkiverse[Quarkiverse Hub]. diff --git a/docs/src/main/asciidoc/flyway.adoc b/docs/src/main/asciidoc/flyway.adoc index 1f28f56ac0f6e..faeee0b253a06 100644 --- a/docs/src/main/asciidoc/flyway.adoc +++ b/docs/src/main/asciidoc/flyway.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Flyway - include::./attributes.adoc[] +:categories: data +:summary: This guide covers how to use the Flyway extension to manage your schema migrations. :migrations-path: src/main/resources/db/migration :config-file: application.properties diff --git a/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc b/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc index 7814efdc073b0..9a11f1748204a 100644 --- a/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc +++ b/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy HTTP Binding with Amazon Lambda  :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains Funqy's Amazon Lambda HTTP binding. If you want to allow HTTP clients to invoke on your Funqy functions on AWS Lambda, Quarkus allows you to expose multiple Funqy functions through HTTP deployed as one AWS Lambda. This approach does add overhead over the diff --git a/docs/src/main/asciidoc/funqy-amazon-lambda.adoc b/docs/src/main/asciidoc/funqy-amazon-lambda.adoc index 0f725ba9ac9e3..53c82d7090ec8 100644 --- a/docs/src/main/asciidoc/funqy-amazon-lambda.adoc +++ b/docs/src/main/asciidoc/funqy-amazon-lambda.adoc @@ -6,8 +6,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Funqy Amazon Lambda Binding :extension-status: preview :devtools-no-gradle: - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains Funqy's Amazon Lambda binding. The guide walks through quickstart code to show you how you can deploy Funqy functions to Amazon Lambda. diff --git a/docs/src/main/asciidoc/funqy-azure-functions-http.adoc b/docs/src/main/asciidoc/funqy-azure-functions-http.adoc index 3d888d302e754..e6a458ee1571c 100644 --- a/docs/src/main/asciidoc/funqy-azure-functions-http.adoc +++ b/docs/src/main/asciidoc/funqy-azure-functions-http.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy HTTP Binding with Azure Functions :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains Funqy's Azure Functions HTTP binding. You can use xref:funqy-http.adoc[Funqy HTTP] on Azure Functions. This allows you to invoke on multiple Funqy functions using HTTP deployed as one Azure Function. diff --git a/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc b/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc index 4384cad7944a7..9da8deb240dc1 100644 --- a/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc +++ b/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy HTTP Binding with Google Cloud Functions :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains Funqy's Google Cloud Platform Functions HTTP binding. If you want to allow HTTP clients to invoke your Funqy functions on Google Cloud Functions, Quarkus allows you to expose multiple Funqy functions through HTTP deployed as one Google Cloud Function. This approach does add overhead over the diff --git a/docs/src/main/asciidoc/funqy-gcp-functions.adoc b/docs/src/main/asciidoc/funqy-gcp-functions.adoc index da5ca176738fe..77b8250dcae22 100644 --- a/docs/src/main/asciidoc/funqy-gcp-functions.adoc +++ b/docs/src/main/asciidoc/funqy-gcp-functions.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy Google Cloud Functions :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains Funqy's Google Cloud Platform Functions binding. The guide walks through quickstart code to show you how you can deploy Funqy functions to Google Cloud Functions. diff --git a/docs/src/main/asciidoc/funqy-http.adoc b/docs/src/main/asciidoc/funqy-http.adoc index 6bb43c5fb2c9f..df8f4f03c9368 100644 --- a/docs/src/main/asciidoc/funqy-http.adoc +++ b/docs/src/main/asciidoc/funqy-http.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy HTTP Binding (Standalone) - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains Funqy's HTTP binding. :extension-status: preview The guide walks through quickstart code to show you how you can deploy Funqy as a diff --git a/docs/src/main/asciidoc/funqy-knative-events.adoc b/docs/src/main/asciidoc/funqy-knative-events.adoc index f6eaca00d640f..ff681baf397f5 100644 --- a/docs/src/main/asciidoc/funqy-knative-events.adoc +++ b/docs/src/main/asciidoc/funqy-knative-events.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy Knative Events Binding - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains Funqy's Knative Events binding. :extension-status: preview :devtools-no-gradle: diff --git a/docs/src/main/asciidoc/funqy.adoc b/docs/src/main/asciidoc/funqy.adoc index b08b44f45d178..92ee0756e2c71 100644 --- a/docs/src/main/asciidoc/funqy.adoc +++ b/docs/src/main/asciidoc/funqy.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains basics of the Funqy framework, a simple portable cross-provider cloud function API. :extension-status: preview Quarkus Funqy is part of Quarkus's serverless strategy and aims to provide a portable Java API to write functions diff --git a/docs/src/main/asciidoc/gcp-functions-http.adoc b/docs/src/main/asciidoc/gcp-functions-http.adoc index ee3595b18a10a..b39ea679e2af0 100644 --- a/docs/src/main/asciidoc/gcp-functions-http.adoc +++ b/docs/src/main/asciidoc/gcp-functions-http.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Google Cloud Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as a Google Cloud Function. The `quarkus-google-cloud-functions-http` extension allows you to write microservices with RESTEasy Reactive (JAX-RS), Undertow (Servlet), Reactive Routes, or xref:funqy-http.adoc[Funqy HTTP], and make these microservices deployable to the Google Cloud Functions runtime. diff --git a/docs/src/main/asciidoc/gcp-functions.adoc b/docs/src/main/asciidoc/gcp-functions.adoc index 2b0142064d9af..c1e1dc54d26c9 100644 --- a/docs/src/main/asciidoc/gcp-functions.adoc +++ b/docs/src/main/asciidoc/gcp-functions.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Google Cloud Functions (Serverless) :extension-status: preview - include::./attributes.adoc[] +:categories: cloud +:summary: This guide explains how you can deploy Quarkus-based Google Cloud Functions. The `quarkus-google-cloud-functions` extension allows you to use Quarkus to build your Google Cloud Functions. Your functions can use injection annotations from CDI or Spring and other Quarkus facilities as you need them. diff --git a/docs/src/main/asciidoc/getting-started-reactive.adoc b/docs/src/main/asciidoc/getting-started-reactive.adoc index a51041763108a..de6c3ddaae7b6 100644 --- a/docs/src/main/asciidoc/getting-started-reactive.adoc +++ b/docs/src/main/asciidoc/getting-started-reactive.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Getting Started With Reactive - include::./attributes.adoc[] +:categories: getting-started +:summary: Learn more about developing reactive applications with Quarkus. _Reactive_ is a set of principles to build robust, efficient, and concurrent applications and systems. These principles let you handle more load than traditional approaches while using the resources (CPU and memory) more efficiently while also reacting to failures gracefully. diff --git a/docs/src/main/asciidoc/getting-started-testing.adoc b/docs/src/main/asciidoc/getting-started-testing.adoc index 51b9ad30225c8..67158f204029a 100644 --- a/docs/src/main/asciidoc/getting-started-testing.adoc +++ b/docs/src/main/asciidoc/getting-started-testing.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Testing Your Application - include::./attributes.adoc[] - +:categories: core +:summary: This guide covers testing in JVM mode, native mode, and injection of resources into tests :toc: macro :toclevels: 4 :doctype: book diff --git a/docs/src/main/asciidoc/getting-started.adoc b/docs/src/main/asciidoc/getting-started.adoc index 6cb5aa9eb7a52..753772fc82d39 100644 --- a/docs/src/main/asciidoc/getting-started.adoc +++ b/docs/src/main/asciidoc/getting-started.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Creating Your First Application include::./attributes.adoc[] +:categories: getting-started +:summary: Discover how to create your first Quarkus application. :toc: macro :toclevels: 4 :doctype: book diff --git a/docs/src/main/asciidoc/gradle-tooling.adoc b/docs/src/main/asciidoc/gradle-tooling.adoc index f53e6537de0e5..df7d0cb7c16fb 100644 --- a/docs/src/main/asciidoc/gradle-tooling.adoc +++ b/docs/src/main/asciidoc/gradle-tooling.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Building Quarkus apps with Gradle - include::./attributes.adoc[] +:categories: tooling +:summary: This guide covers: Gradle configuration, creating a new project, dealing with extensions, development mode, debugging, import in your IDE, building a native image, and build a container friendly executable :devtools-no-maven: [[project-creation]] diff --git a/docs/src/main/asciidoc/grpc-getting-started.adoc b/docs/src/main/asciidoc/grpc-getting-started.adoc index 353a0360c56aa..5693a97a46871 100644 --- a/docs/src/main/asciidoc/grpc-getting-started.adoc +++ b/docs/src/main/asciidoc/grpc-getting-started.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Getting Started with gRPC - include::./attributes.adoc[] +:categories: serialization +:summary: This guide explains how to start using gRPC in your Quarkus application. This page explains how to start using gRPC in your Quarkus application. While this page describes how to configure it with Maven, it is also possible to use Gradle. diff --git a/docs/src/main/asciidoc/grpc-service-consumption.adoc b/docs/src/main/asciidoc/grpc-service-consumption.adoc index 2936a0dfc5307..997f6a4ceed42 100644 --- a/docs/src/main/asciidoc/grpc-service-consumption.adoc +++ b/docs/src/main/asciidoc/grpc-service-consumption.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Consuming a gRPC Service - include::./attributes.adoc[] +:categories: serialization +:summary: This guide explains how to consume gRPC services in your Quarkus application. gRPC clients can be injected in your application code. diff --git a/docs/src/main/asciidoc/grpc-service-implementation.adoc b/docs/src/main/asciidoc/grpc-service-implementation.adoc index 82ec98d1aebd1..e5281acc61411 100644 --- a/docs/src/main/asciidoc/grpc-service-implementation.adoc +++ b/docs/src/main/asciidoc/grpc-service-implementation.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Implementing a gRPC Service - include::./attributes.adoc[] +:categories: serialization +:summary: This guide explains how to implement gRPC services in your Quarkus application. gRPC service implementations exposed as CDI beans are automatically registered and served by quarkus-grpc. diff --git a/docs/src/main/asciidoc/grpc.adoc b/docs/src/main/asciidoc/grpc.adoc index fb4ecc50281cf..173d45ea22d1f 100644 --- a/docs/src/main/asciidoc/grpc.adoc +++ b/docs/src/main/asciidoc/grpc.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = gRPC - include::./attributes.adoc[] +:categories: serialization +:summary: Entry point for everything gRPC. https://grpc.io/[gRPC] is a high-performance RPC framework. It can efficiently connect services implemented using various languages and frameworks. diff --git a/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc b/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc index 2faf13d54cb13..bd979fa302296 100644 --- a/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc +++ b/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Simplified Hibernate ORM with Panache and Kotlin - include::./attributes.adoc[] +:categories: data, alt-languages +:summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project. :config-file: application.properties Hibernate ORM is the de facto standard JPA implementation and is well-known in the Java ecosystem. Hibernate ORM with Panache offers a diff --git a/docs/src/main/asciidoc/hibernate-orm-panache.adoc b/docs/src/main/asciidoc/hibernate-orm-panache.adoc index 5008778c42402..bd9a7d4efcfa6 100644 --- a/docs/src/main/asciidoc/hibernate-orm-panache.adoc +++ b/docs/src/main/asciidoc/hibernate-orm-panache.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Simplified Hibernate ORM with Panache - include::./attributes.adoc[] +:categories: data +:summary: Hibernate ORM is the de facto JPA implementation and offers you the full breadth of an Object Relational Mapper. It makes complex mappings possible, but it does not make simple and common mappings trivial. Panache focuses on making your entities trivial and fun to write. :config-file: application.properties Hibernate ORM is the de facto JPA implementation and offers you the full breadth of an Object Relational Mapper. diff --git a/docs/src/main/asciidoc/hibernate-orm.adoc b/docs/src/main/asciidoc/hibernate-orm.adoc index 04d4853c9619b..a2b243b5b043d 100644 --- a/docs/src/main/asciidoc/hibernate-orm.adoc +++ b/docs/src/main/asciidoc/hibernate-orm.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Hibernate ORM and JPA - include::./attributes.adoc[] +:categories: data +:summary: Hibernate ORM is the de facto JPA implementation and offers you the full breath of an Object Relational Mapper. It works beautifully in Quarkus. :config-file: application.properties :orm-doc-url-prefix: https://docs.jboss.org/hibernate/orm/5.6/userguide/html_single/Hibernate_User_Guide.html diff --git a/docs/src/main/asciidoc/hibernate-reactive-panache.adoc b/docs/src/main/asciidoc/hibernate-reactive-panache.adoc index d9baf896d6cee..21944fe821395 100644 --- a/docs/src/main/asciidoc/hibernate-reactive-panache.adoc +++ b/docs/src/main/asciidoc/hibernate-reactive-panache.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Simplified Hibernate Reactive with Panache - include::./attributes.adoc[] +:categories: data +:summary: Simplified reactive ORM layer based on Hibernate Reactive. :config-file: application.properties link:https://hibernate.org/reactive/[Hibernate Reactive] is the only reactive JPA implementation and offers you the full diff --git a/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc b/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc index f762133986557..60b6309361db4 100644 --- a/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc +++ b/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc @@ -6,6 +6,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Hibernate Search guide :hibernate-search-doc-prefix: https://docs.jboss.org/hibernate/search/6.1/reference/en-US/html_single/ include::./attributes.adoc[] +:categories: data +:summary: Hibernate Search allows you to index your entities in an Elasticsearch cluster and easily offer full text search in all your Hibernate ORM-based applications. You have a Hibernate ORM-based application? You want to provide a full-featured full-text search to your users? You're at the right place. diff --git a/docs/src/main/asciidoc/http-reference.adoc b/docs/src/main/asciidoc/http-reference.adoc index 3633a29e46301..9fd3e2b2cd442 100644 --- a/docs/src/main/asciidoc/http-reference.adoc +++ b/docs/src/main/asciidoc/http-reference.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = HTTP Reference - include::./attributes.adoc[] +:categories: web +:summary: Learn more about configuring Quarkus' Vert.x based HTTP layer - and Undertow if you are using servlets. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/ide-tooling.adoc b/docs/src/main/asciidoc/ide-tooling.adoc index bb76302fd80cb..7be4621e896a7 100644 --- a/docs/src/main/asciidoc/ide-tooling.adoc +++ b/docs/src/main/asciidoc/ide-tooling.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Tools in your favorite IDE - include::./attributes.adoc[] +:categories: getting-started +:summary: Learn more about Quarkus integrations in IDEs. The following IDEs have support for the community developed Quarkus Tools: diff --git a/docs/src/main/asciidoc/infinispan-client.adoc b/docs/src/main/asciidoc/infinispan-client.adoc index 4b4dd61c9b3a7..e134f88b77261 100644 --- a/docs/src/main/asciidoc/infinispan-client.adoc +++ b/docs/src/main/asciidoc/infinispan-client.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Infinispan Client - include::./attributes.adoc[] +:categories: data +:summary: Infinispan is an in memory data grid that allows running in a server outside of application processes. This extension provides functionality to allow the client that can connect to said server when running in Quarkus. Infinispan is a distributed, in-memory key/value store that provides Quarkus applications with a highly configurable and independently scalable data layer. diff --git a/docs/src/main/asciidoc/jms.adoc b/docs/src/main/asciidoc/jms.adoc index 51f8e37aa95e8..ef4af8535844a 100644 --- a/docs/src/main/asciidoc/jms.adoc +++ b/docs/src/main/asciidoc/jms.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using JMS include::./attributes.adoc[] +:categories: messaging +:summary: This guide demonstrates how your Quarkus application can use JMS messaging with AMQP 1.0 using Apache Qpid JMS, or using Apache ActiveMQ Artemis JMS. :extension-status: preview diff --git a/docs/src/main/asciidoc/kafka-dev-services.adoc b/docs/src/main/asciidoc/kafka-dev-services.adoc index a56f2c4df94d9..299c269167575 100644 --- a/docs/src/main/asciidoc/kafka-dev-services.adoc +++ b/docs/src/main/asciidoc/kafka-dev-services.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for Kafka - include::./attributes.adoc[] +:categories: messaging +:summary: Start Apache Kafka automatically in dev and test modes. 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. So, you don't have to start a broker manually. diff --git a/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc b/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc index 04a5f04f11c66..99c1d5c39c9d1 100644 --- a/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc +++ b/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Getting Started to SmallRye Reactive Messaging with Apache Kafka - include::./attributes.adoc[] +:categories: messaging +:summary: This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with Apache Kafka. This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with Apache Kafka. diff --git a/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc b/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc index 8c06be867948b..785b6341b6029 100644 --- a/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc +++ b/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Apache Kafka with Schema Registry and Avro - include::./attributes.adoc[] +:categories: messaging +:summary: Use Apache Kafka, Avro serialized records, and connect to a schema registry. This guide shows how your Quarkus application can use Apache Kafka, https://avro.apache.org/docs/current/[Avro] serialized records, and connect to a schema registry (such as the https://docs.confluent.io/platform/current/schema-registry/index.html[Confluent Schema Registry] or https://www.apicur.io/registry/[Apicurio Registry]). diff --git a/docs/src/main/asciidoc/kafka-streams.adoc b/docs/src/main/asciidoc/kafka-streams.adoc index 870d8b65a97cf..47a058fc93c84 100644 --- a/docs/src/main/asciidoc/kafka-streams.adoc +++ b/docs/src/main/asciidoc/kafka-streams.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Apache Kafka Streams - include::./attributes.adoc[] +:categories: messaging +:summary: This guide demonstrates how your Quarkus application can utilize the Apache Kafka Streams API to implement stream processing applications based on Apache Kafka. This guide demonstrates how your Quarkus application can utilize the Apache Kafka Streams API to implement stream processing applications based on Apache Kafka. diff --git a/docs/src/main/asciidoc/kafka.adoc b/docs/src/main/asciidoc/kafka.adoc index a8281d1280a9a..d2eb3fbb52b98 100644 --- a/docs/src/main/asciidoc/kafka.adoc +++ b/docs/src/main/asciidoc/kafka.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Apache Kafka Reference Guide - include::./attributes.adoc[] - +:categories: messaging +:summary: This reference guide provides an in-depth look on Apache Kafka and Smallrye Reactive Messaging framework. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/kogito-dmn.adoc b/docs/src/main/asciidoc/kogito-dmn.adoc index 0d72590f1c06b..19cf5cb980293 100644 --- a/docs/src/main/asciidoc/kogito-dmn.adoc +++ b/docs/src/main/asciidoc/kogito-dmn.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Kogito DMN support to add decision automation capabilities to an application - include::./attributes.adoc[] +:categories: business-automation +:summary: Use Kogito to add business automation and power it up with DMN decision support. This guide demonstrates how your Quarkus application can use Kogito to add business automation and power it up with DMN decision support. diff --git a/docs/src/main/asciidoc/kogito-drl.adoc b/docs/src/main/asciidoc/kogito-drl.adoc index 586d25890ad94..c9d62d855ba43 100644 --- a/docs/src/main/asciidoc/kogito-drl.adoc +++ b/docs/src/main/asciidoc/kogito-drl.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Kogito to add rule engine capabilities to an application - include::./attributes.adoc[] +:categories: business-automation +:summary: Use Kogito to add DRL files with rules. This guide demonstrates how your Quarkus application can use Kogito to add DRL files with rules. diff --git a/docs/src/main/asciidoc/kogito-pmml.adoc b/docs/src/main/asciidoc/kogito-pmml.adoc index d74cfaac85eaa..42a97720e615c 100644 --- a/docs/src/main/asciidoc/kogito-pmml.adoc +++ b/docs/src/main/asciidoc/kogito-pmml.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Kogito to add prediction capabilities to an application - include::./attributes.adoc[] +:categories: business-automation +:summary: Use Kogito to add business automation to power it up with predictions. This guide demonstrates how your Quarkus application can use Kogito to add business automation to power it up with predictions. diff --git a/docs/src/main/asciidoc/kogito.adoc b/docs/src/main/asciidoc/kogito.adoc index 0fc365377d658..2f30b19ca7697 100644 --- a/docs/src/main/asciidoc/kogito.adoc +++ b/docs/src/main/asciidoc/kogito.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Kogito to add business automation capabilities to an application - include::./attributes.adoc[] +:categories: business-automation +:summary: This guide demonstrates how your Quarkus application can use Kogito to add business automation to power it up with business processes and rules. This guide demonstrates how your Quarkus application can use Kogito to add business automation to power it up with business processes and rules. diff --git a/docs/src/main/asciidoc/kotlin.adoc b/docs/src/main/asciidoc/kotlin.adoc index 756722b822332..094a0e75e53a4 100644 --- a/docs/src/main/asciidoc/kotlin.adoc +++ b/docs/src/main/asciidoc/kotlin.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Kotlin - include::./attributes.adoc[] +:categories: alt-languages +:summary: This guide explains how to use Kotlin. https://kotlinlang.org/[Kotlin] is a very popular programming language that targets the JVM (amongst other environments). Kotlin has experienced a surge in popularity the last few years making it the most popular JVM language, except for Java of course. diff --git a/docs/src/main/asciidoc/kubernetes-client.adoc b/docs/src/main/asciidoc/kubernetes-client.adoc index d2d5efe604636..7b084f0af034b 100644 --- a/docs/src/main/asciidoc/kubernetes-client.adoc +++ b/docs/src/main/asciidoc/kubernetes-client.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Kubernetes Client - include::./attributes.adoc[] +:categories: cloud +:summary: This guide demonstrates how to use the Fabric8 Kubernetes client to interact with your Kubernetes cluster. Quarkus includes the `kubernetes-client` extension which enables the use of the https://github.com/fabric8io/kubernetes-client[Fabric8 Kubernetes Client] diff --git a/docs/src/main/asciidoc/kubernetes-config.adoc b/docs/src/main/asciidoc/kubernetes-config.adoc index 87fab5ccdc40d..722fc22c58db5 100644 --- a/docs/src/main/asciidoc/kubernetes-config.adoc +++ b/docs/src/main/asciidoc/kubernetes-config.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Kubernetes Config - include::./attributes.adoc[] +:categories: cloud +:summary: Use ConfigMaps as a configuration source for your Quarkus applications. Quarkus includes the `kubernetes-config` extension which allows developers to use Kubernetes https://cloud.google.com/kubernetes-engine/docs/concepts/configmap[ConfigMaps] and https://cloud.google.com/kubernetes-engine/docs/concepts/secret[Secrets] as a configuration source, without having to mount them into the https://kubernetes.io/docs/concepts/workloads/pods/pod/[Pod] running the Quarkus application or make any other modifications to their Kubernetes `Deployment` (or OpenShift `DeploymentConfig`). diff --git a/docs/src/main/asciidoc/lifecycle.adoc b/docs/src/main/asciidoc/lifecycle.adoc index 7b9510199e0ce..a6dedf77f215a 100644 --- a/docs/src/main/asciidoc/lifecycle.adoc +++ b/docs/src/main/asciidoc/lifecycle.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Application Initialization and Termination - include::./attributes.adoc[] +:categories: core +: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. 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/liquibase.adoc b/docs/src/main/asciidoc/liquibase.adoc index d7119945791ce..e441ae7a4efad 100644 --- a/docs/src/main/asciidoc/liquibase.adoc +++ b/docs/src/main/asciidoc/liquibase.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Liquibase - include::./attributes.adoc[] +:categories: data +:summary: This guide covers how to use the Liquibase extension to manage your schema migrations. :change-log: src/main/resources/db/changeLog.xml :config-file: application.properties diff --git a/docs/src/main/asciidoc/logging.adoc b/docs/src/main/asciidoc/logging.adoc index 3a5cb4a1cec3f..e61f99ecfc2fc 100644 --- a/docs/src/main/asciidoc/logging.adoc +++ b/docs/src/main/asciidoc/logging.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Configuring Logging - include::./attributes.adoc[] +:categories: core +:summary: This guide explains logging and how to configure it. This guide explains logging and how to configure it. diff --git a/docs/src/main/asciidoc/lra.adoc b/docs/src/main/asciidoc/lra.adoc index 14d113ca33581..cc0a2152156a0 100644 --- a/docs/src/main/asciidoc/lra.adoc +++ b/docs/src/main/asciidoc/lra.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Narayana LRA Participant Support - include::./attributes.adoc[] +:categories: data +:summary: This guides covers the usage of LRA to coordinate activities across services. == Introduction diff --git a/docs/src/main/asciidoc/mailer-reference.adoc b/docs/src/main/asciidoc/mailer-reference.adoc index 2aa9e6342d6f6..289d4518581f9 100644 --- a/docs/src/main/asciidoc/mailer-reference.adoc +++ b/docs/src/main/asciidoc/mailer-reference.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Mailer Reference Guide - include::./attributes.adoc[] +:categories: miscellaneous +:summary: This reference guide explains in more details the configuration and usage of the Quarkus Mailer. This guide is the companion from the xref:mailer.adoc[Mailer Getting Started Guide]. It explains in more details the configuration and usage of the Quarkus Mailer. diff --git a/docs/src/main/asciidoc/mailer.adoc b/docs/src/main/asciidoc/mailer.adoc index e85271a91c4fa..4a0b0874e3785 100644 --- a/docs/src/main/asciidoc/mailer.adoc +++ b/docs/src/main/asciidoc/mailer.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Sending emails using SMTP - include::./attributes.adoc[] +:categories: miscellaneous +:summary: Learn more about how you can send email from a Quarkus application with our reactive email client. This guide demonstrates how your Quarkus application can send emails using an SMTP server. This is a getting started guide. diff --git a/docs/src/main/asciidoc/maven-tooling.adoc b/docs/src/main/asciidoc/maven-tooling.adoc index 535ffc9f86718..7d6ce8be99fa1 100644 --- a/docs/src/main/asciidoc/maven-tooling.adoc +++ b/docs/src/main/asciidoc/maven-tooling.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Building applications with Maven - include::./attributes.adoc[] +:categories: tooling +:summary: This guide covers: Maven configuration, creating a new project, dealing with extensions, development mode, debugging, import in your IDE, building a native image, and build a container friendly executable :devtools-no-gradle: [[project-creation]] diff --git a/docs/src/main/asciidoc/micrometer.adoc b/docs/src/main/asciidoc/micrometer.adoc index 17da56696fc67..228570c06fea7 100644 --- a/docs/src/main/asciidoc/micrometer.adoc +++ b/docs/src/main/asciidoc/micrometer.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Micrometer Metrics - include::./attributes.adoc[] +:categories: observability +:summary: This guide demonstrates how your Quarkus application can collect metrics using the Micrometer extension. This guide demonstrates how your Quarkus application can utilize the Micrometer metrics library for runtime and application metrics. diff --git a/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc b/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc index c96c289788d9b..5dc441f16314c 100644 --- a/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc +++ b/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Simplified MongoDB with Panache and Kotlin - include::./attributes.adoc[] +:categories: data, alt-languages +:summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project. :config-file: application.properties MongoDB is a well known NoSQL Database that is widely used. MongoDB with Panache offers a diff --git a/docs/src/main/asciidoc/mongodb-panache.adoc b/docs/src/main/asciidoc/mongodb-panache.adoc index 1f62b79f0f368..bad93fc0fddb4 100644 --- a/docs/src/main/asciidoc/mongodb-panache.adoc +++ b/docs/src/main/asciidoc/mongodb-panache.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Simplified MongoDB with Panache - include::./attributes.adoc[] +:categories: data +:summary: This guide covers the usage of MongoDB using active records and repositories. :config-file: application.properties :mongodb-doc-root-url: https://www.mongodb.com/docs/drivers/java/sync/current diff --git a/docs/src/main/asciidoc/mongodb.adoc b/docs/src/main/asciidoc/mongodb.adoc index 579a60418fbbd..a7c1762d0763c 100644 --- a/docs/src/main/asciidoc/mongodb.adoc +++ b/docs/src/main/asciidoc/mongodb.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the MongoDB Client include::./attributes.adoc[] +:categories: data +:summary: This guide covers how to use MongoDB in Quarkus. MongoDB is a well known NoSQL Database that is widely used. diff --git a/docs/src/main/asciidoc/native-and-ssl.adoc b/docs/src/main/asciidoc/native-and-ssl.adoc index da303ad9d6f5f..a63195ed23e8c 100644 --- a/docs/src/main/asciidoc/native-and-ssl.adoc +++ b/docs/src/main/asciidoc/native-and-ssl.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using SSL With Native Executables - include::./attributes.adoc[] +:categories: core +:summary: In this guide, we will discuss how you can get your native images to support SSL, as native images don't support it out of the box. :devtools-no-gradle: We are quickly moving to an SSL-everywhere world so being able to use SSL is crucial. diff --git a/docs/src/main/asciidoc/openapi-swaggerui.adoc b/docs/src/main/asciidoc/openapi-swaggerui.adoc index cb07612948f58..bbd973e14a1d7 100644 --- a/docs/src/main/asciidoc/openapi-swaggerui.adoc +++ b/docs/src/main/asciidoc/openapi-swaggerui.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenAPI and Swagger UI - include::./attributes.adoc[] +:categories: web +:summary: This guide explains how to use the OpenAPI extension to generate an OpenAPI descriptor and get a Swagger UI frontend to test your REST endpoints. This guide explains how your Quarkus application can expose its API description through an OpenAPI specification and how you can test it via a user-friendly UI named Swagger UI. diff --git a/docs/src/main/asciidoc/opentelemetry.adoc b/docs/src/main/asciidoc/opentelemetry.adoc index 2960c3ca14913..58ca4f5192512 100644 --- a/docs/src/main/asciidoc/opentelemetry.adoc +++ b/docs/src/main/asciidoc/opentelemetry.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenTelemetry - include::./attributes.adoc[] +:categories: observability +:summary: This guide explains how your Quarkus application can utilize OpenTelemetry to provide distributed tracing for interactive web applications. This guide explains how your Quarkus application can utilize https://opentelemetry.io/[OpenTelemetry] to provide distributed tracing for interactive web applications. diff --git a/docs/src/main/asciidoc/opentracing.adoc b/docs/src/main/asciidoc/opentracing.adoc index 2905ffb25afc2..8951c29c40493 100644 --- a/docs/src/main/asciidoc/opentracing.adoc +++ b/docs/src/main/asciidoc/opentracing.adoc @@ -5,8 +5,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenTracing :extension-status: deprecated - include::./attributes.adoc[] +:categories: observability +:summary: This guide explains how your Quarkus application can utilize OpenTracing to provide distributed tracing for interactive web applications. This guide explains how your Quarkus application can utilize OpenTracing to provide distributed tracing for interactive web applications. diff --git a/docs/src/main/asciidoc/optaplanner.adoc b/docs/src/main/asciidoc/optaplanner.adoc index dd16950334624..d00bc3754be95 100644 --- a/docs/src/main/asciidoc/optaplanner.adoc +++ b/docs/src/main/asciidoc/optaplanner.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = OptaPlanner - Using AI to optimize a schedule with OptaPlanner - include::./attributes.adoc[] +:categories: business-automation +:summary: This guide walks you through the process of creating a Quarkus application with OptaPlanner's constraint solving Artificial Intelligence (AI). :config-file: application.properties This guide walks you through the process of creating a Quarkus application diff --git a/docs/src/main/asciidoc/performance-measure.adoc b/docs/src/main/asciidoc/performance-measure.adoc index ece6c2d33db6f..c4135610ecb8d 100644 --- a/docs/src/main/asciidoc/performance-measure.adoc +++ b/docs/src/main/asciidoc/performance-measure.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Measuring Performance - include::./attributes.adoc[] +:categories: miscellaneous +:summary: This guide explains how to best measure the footprint of a Quarkus application. This guide covers: diff --git a/docs/src/main/asciidoc/picocli.adoc b/docs/src/main/asciidoc/picocli.adoc index 2c6f8300be9ef..22e8b82b42620 100644 --- a/docs/src/main/asciidoc/picocli.adoc +++ b/docs/src/main/asciidoc/picocli.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Command Mode with Picocli - include::./attributes.adoc[] +:categories: command-line +:summary: Simplify command line applications creation with the Picocli extension. https://picocli.info/[Picocli] is an open source tool for creating rich command line applications. diff --git a/docs/src/main/asciidoc/platform.adoc b/docs/src/main/asciidoc/platform.adoc index 0c84eabd9c323..eea75c06d92b5 100644 --- a/docs/src/main/asciidoc/platform.adoc +++ b/docs/src/main/asciidoc/platform.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Platform - include::./attributes.adoc[] +:categories: architecture +:summary: Learn more about what we call a Platform in the Quarkus world. The Quarkus extension ecosystem consists of the Quarkus extensions developed and maintained by the community, including the Quarkus core development team. While the Quarkus ecosystem (sometimes also referred to as the "Quarkus universe") includes all the Quarkus extensions ever developed, there is also a concept of a Quarkus platform. diff --git a/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc b/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc index b5e19ce25e21c..d12696d6616dc 100644 --- a/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc +++ b/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Reactive Architecture - include::./attributes.adoc[] +:categories: architecture +:summary: Learn more about Quarkus reactive architecture. Quarkus is reactive. It's even more than this: Quarkus unifies reactive and imperative programming. diff --git a/docs/src/main/asciidoc/quartz.adoc b/docs/src/main/asciidoc/quartz.adoc index 27be001e45640..dd896b741dbd7 100644 --- a/docs/src/main/asciidoc/quartz.adoc +++ b/docs/src/main/asciidoc/quartz.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Scheduling Periodic Tasks with Quartz - include::./attributes.adoc[] +:categories: miscellaneous +:summary: You need clustering support for your scheduled tasks? This guide explains how to use the Quartz extension for that. :extension-status: preview Modern applications often need to run specific tasks periodically. diff --git a/docs/src/main/asciidoc/qute-reference.adoc b/docs/src/main/asciidoc/qute-reference.adoc index 2aa334deba19f..07a923b5ee125 100644 --- a/docs/src/main/asciidoc/qute-reference.adoc +++ b/docs/src/main/asciidoc/qute-reference.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Qute Reference Guide - include::./attributes.adoc[] - +:categories: miscellaneous +:summary: Learn everything you need to know about the Qute template engine. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/qute.adoc b/docs/src/main/asciidoc/qute.adoc index b3d32086fbf5b..bf511bb9f46e3 100644 --- a/docs/src/main/asciidoc/qute.adoc +++ b/docs/src/main/asciidoc/qute.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Qute Templating Engine - include::./attributes.adoc[] +:categories: miscellaneous +:summary: Learn more about how you can use templating in your applications with the Qute template engine. Qute is a templating engine designed specifically to meet the Quarkus needs. The usage of reflection is minimized to reduce the size of native images. diff --git a/docs/src/main/asciidoc/reactive-event-bus.adoc b/docs/src/main/asciidoc/reactive-event-bus.adoc index 3b8f5f9101539..91862024ea465 100644 --- a/docs/src/main/asciidoc/reactive-event-bus.adoc +++ b/docs/src/main/asciidoc/reactive-event-bus.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the event bus - include::./attributes.adoc[] +:categories: messaging +:summary: This guide explains how different beans can interact using the event bus. Quarkus allows different beans to interact using asynchronous events, thus promoting loose-coupling. The messages are sent to _virtual addresses_. diff --git a/docs/src/main/asciidoc/reactive-routes.adoc b/docs/src/main/asciidoc/reactive-routes.adoc index c0aea6fe5d580..6d719e6b97e26 100644 --- a/docs/src/main/asciidoc/reactive-routes.adoc +++ b/docs/src/main/asciidoc/reactive-routes.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Reactive Routes - include::./attributes.adoc[] +:categories: web +:summary: This guide demonstrates how to use reactive routes. Reactive routes propose an alternative approach to implement HTTP endpoints where you declare and chain _routes_. This approach became very popular in the JavaScript world, with frameworks like Express.Js or Hapi. diff --git a/docs/src/main/asciidoc/reactive-sql-clients.adoc b/docs/src/main/asciidoc/reactive-sql-clients.adoc index 13d422e44c050..3c5ab8e9d6bc0 100644 --- a/docs/src/main/asciidoc/reactive-sql-clients.adoc +++ b/docs/src/main/asciidoc/reactive-sql-clients.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Reactive SQL Clients - include::./attributes.adoc[] +:categories: data +:summary: This guide covers how to use the Reactive SQL Clients in Quarkus. :config-file: application.properties The Reactive SQL Clients have a straightforward API focusing on scalability and low-overhead. diff --git a/docs/src/main/asciidoc/reaugmentation.adoc b/docs/src/main/asciidoc/reaugmentation.adoc index 000b9fdb824c5..0c66c9fcd0f13 100644 --- a/docs/src/main/asciidoc/reaugmentation.adoc +++ b/docs/src/main/asciidoc/reaugmentation.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Re-augment a Quarkus Application - include::./attributes.adoc[] +:categories: tooling +:summary: Use mutable jars to rebuild your application with different build time configurations. == What is augmentation? diff --git a/docs/src/main/asciidoc/redis-dev-services.adoc b/docs/src/main/asciidoc/redis-dev-services.adoc index 18022f226a980..f9ecf47b5993d 100644 --- a/docs/src/main/asciidoc/redis-dev-services.adoc +++ b/docs/src/main/asciidoc/redis-dev-services.adoc @@ -4,9 +4,10 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for Redis - :extension-status: preview include::./attributes.adoc[] +:categories: data +:summary: Start Redis automatically in dev and test modes. Quarkus supports a feature called Dev Services that allows you to create various datasources without any config. What that means practically, is that if you have docker running and have not configured `quarkus.redis.hosts`, diff --git a/docs/src/main/asciidoc/redis.adoc b/docs/src/main/asciidoc/redis.adoc index 57a2e59c3372f..9644a79b0063c 100644 --- a/docs/src/main/asciidoc/redis.adoc +++ b/docs/src/main/asciidoc/redis.adoc @@ -6,6 +6,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Using the Redis Client :extension-status: preview include::./attributes.adoc[] +:categories: data +:summary: This guide covers how to use a Redis datastore in Quarkus. This guide demonstrates how your Quarkus application can connect to a Redis server using the Redis Client extension. diff --git a/docs/src/main/asciidoc/rest-client-multipart.adoc b/docs/src/main/asciidoc/rest-client-multipart.adoc index db71e5e017b7e..fbfa3587c1ab8 100644 --- a/docs/src/main/asciidoc/rest-client-multipart.adoc +++ b/docs/src/main/asciidoc/rest-client-multipart.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the REST Client with Multipart - include::./attributes.adoc[] +:categories: web +:summary: This guide explains how to use the RESTEasy REST Client to send multipart REST requests, typically to upload documents. [WARNING] ==== diff --git a/docs/src/main/asciidoc/rest-client-reactive.adoc b/docs/src/main/asciidoc/rest-client-reactive.adoc index 8a0643ed9bb25..8e84aee3392a4 100644 --- a/docs/src/main/asciidoc/rest-client-reactive.adoc +++ b/docs/src/main/asciidoc/rest-client-reactive.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the REST Client Reactive - include::./attributes.adoc[] +:categories: web +:summary: This guide explains how to use the RESTEasy Reactive REST Client. This guide explains how to use the REST Client Reactive in order to interact with REST APIs. REST Client Reactive is the REST Client implementation compatible with RESTEasy Reactive. diff --git a/docs/src/main/asciidoc/rest-client.adoc b/docs/src/main/asciidoc/rest-client.adoc index 9326bd4746804..04d46b711192a 100644 --- a/docs/src/main/asciidoc/rest-client.adoc +++ b/docs/src/main/asciidoc/rest-client.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the REST Client - include::./attributes.adoc[] +:categories: web +:summary: This guide explains how to use the RESTEasy REST Client in order to interact with REST APIs (JSON and other) with very little effort. [WARNING] ==== diff --git a/docs/src/main/asciidoc/rest-data-panache.adoc b/docs/src/main/asciidoc/rest-data-panache.adoc index dbb39fc014365..83a7b37769a47 100644 --- a/docs/src/main/asciidoc/rest-data-panache.adoc +++ b/docs/src/main/asciidoc/rest-data-panache.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Generating JAX-RS resources with Panache - include::./attributes.adoc[] +:categories: web +:summary: Hibernate ORM REST Data with Panache simplifies the creation of CRUD applications based on JAX-RS and Hibernate ORM. :extension-status: experimental A lot of web applications are monotonous CRUD applications with REST APIs that are tedious to write. diff --git a/docs/src/main/asciidoc/rest-json.adoc b/docs/src/main/asciidoc/rest-json.adoc index b9de4c432d490..537e24da2dc33 100644 --- a/docs/src/main/asciidoc/rest-json.adoc +++ b/docs/src/main/asciidoc/rest-json.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Writing JSON REST Services - include::./attributes.adoc[] +:categories: web, serialization +:summary: JSON is now the lingua franca between microservices. In this guide, we see how you can get your REST services to consume and produce JSON payloads. JSON is now the _lingua franca_ between microservices. diff --git a/docs/src/main/asciidoc/resteasy-reactive.adoc b/docs/src/main/asciidoc/resteasy-reactive.adoc index 963d5b5af9209..39f6b55a5c524 100644 --- a/docs/src/main/asciidoc/resteasy-reactive.adoc +++ b/docs/src/main/asciidoc/resteasy-reactive.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Writing REST Services with RESTEasy Reactive - include::./attributes.adoc[] +:categories: web +:summary: Discover how to develop highly scalable reactive REST services with JAX-RS and RESTEasy Reactive. :jaxrsapi: https://javadoc.io/doc/javax.ws.rs/javax.ws.rs-api/2.1.1 :jaxrsspec: /specs/jaxrs/2.1/index.html :jdkapi: https://docs.oracle.com/en/java/javase/11/docs/api/java.base diff --git a/docs/src/main/asciidoc/scheduler-reference.adoc b/docs/src/main/asciidoc/scheduler-reference.adoc index e70bfe2cc2a12..05dfd67251d15 100644 --- a/docs/src/main/asciidoc/scheduler-reference.adoc +++ b/docs/src/main/asciidoc/scheduler-reference.adoc @@ -4,9 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Scheduler Reference Guide - include::./attributes.adoc[] - +:categories: miscellaneous +:summary: Learn more about the Scheduler extension. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/scheduler.adoc b/docs/src/main/asciidoc/scheduler.adoc index 41e4cdd4341ff..e165cf67d9f4b 100644 --- a/docs/src/main/asciidoc/scheduler.adoc +++ b/docs/src/main/asciidoc/scheduler.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Scheduling Periodic Tasks - include::./attributes.adoc[] +:categories: miscellaneous +:summary: Modern applications often need to run specific tasks periodically. In this guide, you learn how to schedule periodic tasks. Modern applications often need to run specific tasks periodically. In this guide, you learn how to schedule periodic tasks. diff --git a/docs/src/main/asciidoc/scripting.adoc b/docs/src/main/asciidoc/scripting.adoc index 4515e1ec34de1..7afcb970ed363 100644 --- a/docs/src/main/asciidoc/scripting.adoc +++ b/docs/src/main/asciidoc/scripting.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Scripting with Quarkus include::./attributes.adoc[] +:categories: command-line +:summary: Easy Quarkus-based scripting with jbang. :extension-status: preview Quarkus provides integration with https://jbang.dev[jbang] which allows you to write Java scripts/applications requiring no Maven nor Gradle to get running. diff --git a/docs/src/main/asciidoc/security-jdbc.adoc b/docs/src/main/asciidoc/security-jdbc.adoc index a7948980548bf..2864cb0b22e7f 100644 --- a/docs/src/main/asciidoc/security-jdbc.adoc +++ b/docs/src/main/asciidoc/security-jdbc.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Security with JDBC - include::./attributes.adoc[] +:categories: security +:summary: This guide demonstrates how your Quarkus application can use a database to store your user identities. This guide demonstrates how your Quarkus application can use a database to store your user identities. diff --git a/docs/src/main/asciidoc/security-jwt.adoc b/docs/src/main/asciidoc/security-jwt.adoc index a0ee26cfbc182..b58e40642b2cc 100644 --- a/docs/src/main/asciidoc/security-jwt.adoc +++ b/docs/src/main/asciidoc/security-jwt.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using JWT RBAC - include::./attributes.adoc[] +:categories: security +:summary: This guide explains how your application can utilize SmallRye JWT to provide secured access to the JAX-RS endpoints. :extension-name: SmallRye JWT :mp-jwt: MicroProfile JWT RBAC diff --git a/docs/src/main/asciidoc/security-keycloak-authorization.adoc b/docs/src/main/asciidoc/security-keycloak-authorization.adoc index 0a28250b5deba..c3da97480c563 100644 --- a/docs/src/main/asciidoc/security-keycloak-authorization.adoc +++ b/docs/src/main/asciidoc/security-keycloak-authorization.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenID Connect (OIDC) and Keycloak to Centralize Authorization - include::./attributes.adoc[] +:categories: security +:summary: This guide demonstrates how your Quarkus application can authorize access to protected resources using Keycloak Authorization Services. This guide demonstrates how your Quarkus application can authorize a bearer token access to protected resources using https://www.keycloak.org/docs/latest/authorization_services/index.html[Keycloak Authorization Services]. diff --git a/docs/src/main/asciidoc/security-ldap.adoc b/docs/src/main/asciidoc/security-ldap.adoc index a78fea6e73b86..9175d942c59f5 100644 --- a/docs/src/main/asciidoc/security-ldap.adoc +++ b/docs/src/main/asciidoc/security-ldap.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Security with an LDAP Realm - include::./attributes.adoc[] +:categories: security +:summary: This guide demonstrates how your Quarkus application can use a LDAP directory to store your user identities. This guide demonstrates how your Quarkus application can use an LDAP server to authenticate and authorize your user identities. diff --git a/docs/src/main/asciidoc/security-oauth2.adoc b/docs/src/main/asciidoc/security-oauth2.adoc index db081834aa639..680f37c3fd26a 100644 --- a/docs/src/main/asciidoc/security-oauth2.adoc +++ b/docs/src/main/asciidoc/security-oauth2.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OAuth2 RBAC - include::./attributes.adoc[] +:categories: security +:summary: This guide explains how your Quarkus application can utilize OAuth2 tokens to provide secured access to the JAX-RS endpoints. :extension-name: Elytron Security OAuth2 This guide explains how your Quarkus application can utilize OAuth2 tokens to provide secured access to the JAX-RS endpoints. diff --git a/docs/src/main/asciidoc/security-openid-connect-client.adoc b/docs/src/main/asciidoc/security-openid-connect-client.adoc index 238d75d9ae6aa..4045042a74344 100644 --- a/docs/src/main/asciidoc/security-openid-connect-client.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-client.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = OpenID Connect Client and Token Propagation Quickstart - include::./attributes.adoc[] +:categories: security +:summary: This guide explains how to use OpenID Connect and OAuth2 Client and Filters to acquire, refresh and propagate access tokens. :toc: This quickstart demonstrates how to use `OpenID Connect Client Reactive Filter` to acquire and propagate access tokens as `HTTP Authorization Bearer` access tokens, alongside `OpenID Token Propagation Reactive Filter` which propagates the incoming `HTTP Authorization Bearer` access tokens. diff --git a/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc b/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc index 65051f176f6f1..eba4429548344 100644 --- a/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services and UI for OpenID Connect (OIDC) - include::./attributes.adoc[] +:categories: security +:summary: Start Keycloak or other providers automatically in dev and test modes. 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. It also describes Dev UI for all OpenID Connect providers which have already been started before Quarkus is launched in a dev mode. diff --git a/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc b/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc index ff217bd31ba4b..9261e8a65a316 100644 --- a/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenID Connect (OIDC) Multi-Tenancy - include::./attributes.adoc[] +:categories: security +:summary: This guide demonstrates how your OpenID Connect application can support multi-tenancy so that you can serve multiple tenants from a single application. :toc: This guide demonstrates how your OpenID Connect (OIDC) application can support multi-tenancy so that you can serve multiple tenants from a single application. Tenants can be distinct realms or security domains within the same OpenID Provider or even distinct OpenID Providers. diff --git a/docs/src/main/asciidoc/security-openid-connect-web-authentication.adoc b/docs/src/main/asciidoc/security-openid-connect-web-authentication.adoc index c15474e51f1ab..b652232978e98 100644 --- a/docs/src/main/asciidoc/security-openid-connect-web-authentication.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-web-authentication.adoc @@ -5,6 +5,8 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = OpenID Connect (OIDC) authorization code flow mechanism include::./attributes.adoc[] +:categories: security +:summary: This guide demonstrates how to use the OpenID Connect Extension to protect your web application based on the Authorization Code Flow using Quarkus. :toc: The Quarkus OpenID Connect (OIDC) extension can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism supported by OIDC-compliant authorization servers, such as https://www.keycloak.org[Keycloak]. diff --git a/docs/src/main/asciidoc/security-openid-connect.adoc b/docs/src/main/asciidoc/security-openid-connect.adoc index af0f39765b706..20005509bd983 100644 --- a/docs/src/main/asciidoc/security-openid-connect.adoc +++ b/docs/src/main/asciidoc/security-openid-connect.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenID Connect (OIDC) to Protect Service Applications using Bearer Token Authorization - include::./attributes.adoc[] +:categories: security +:summary: This guide demonstrates how your Quarkus application can use Keycloak to protect your JAX-RS applications using bearer token authorization, where these tokens are issued by a Keycloak server. :toc: You can use the Quarkus OpenID Connect (OIDC) extension to secure your JAX-RS applications using Bearer Token Authorization. diff --git a/docs/src/main/asciidoc/security-properties.adoc b/docs/src/main/asciidoc/security-properties.adoc index 8c0418027ae83..c7cea6349cfb3 100644 --- a/docs/src/main/asciidoc/security-properties.adoc +++ b/docs/src/main/asciidoc/security-properties.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Security with .properties File - include::./attributes.adoc[] +:categories: security +:summary: This guide demonstrates how your Quarkus application can use a .properties file to store your user identities. Quarkus provides support for properties file based authentication that is intended for development and testing purposes. It is not recommended that this be used in production as at present only diff --git a/docs/src/main/asciidoc/security.adoc b/docs/src/main/asciidoc/security.adoc index 89ddb68c619e8..60c7fc8cfd267 100644 --- a/docs/src/main/asciidoc/security.adoc +++ b/docs/src/main/asciidoc/security.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Security overview - include::./attributes.adoc[] +:categories: security +:summary: This guide is the entry point for everything security in Quarkus. Quarkus Security is a framework that provides the architecture, multiple authentication and authorization mechanisms, and other tools for you to build secure and production-quality Java applications. diff --git a/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc b/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc index 8e99e2aa0ad14..fea6531bd047a 100644 --- a/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc +++ b/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye Fault Tolerance - include::./attributes.adoc[] +:categories: web, observability +:summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension. One of the challenges brought by the distributed nature of microservices is that communication with external systems is inherently unreliable. This increases demand on resiliency of applications. To simplify making more resilient diff --git a/docs/src/main/asciidoc/smallrye-graphql-client.adoc b/docs/src/main/asciidoc/smallrye-graphql-client.adoc index 2ce95bed0d273..7ac4cada0a413 100644 --- a/docs/src/main/asciidoc/smallrye-graphql-client.adoc +++ b/docs/src/main/asciidoc/smallrye-graphql-client.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye GraphQL Client - include::./attributes.adoc[] +:categories: web +:summary: This guide explains how to leverage SmallRye GraphQL Client to consume GraphQL services. This guide demonstrates how your Quarkus application can use the GraphQL client library. The client is implemented by the https://github.com/smallrye/smallrye-graphql/[SmallRye GraphQL] project. diff --git a/docs/src/main/asciidoc/smallrye-graphql.adoc b/docs/src/main/asciidoc/smallrye-graphql.adoc index 832deb1dfbae2..5aa3edc3121f6 100644 --- a/docs/src/main/asciidoc/smallrye-graphql.adoc +++ b/docs/src/main/asciidoc/smallrye-graphql.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye GraphQL - include::./attributes.adoc[] +:categories: web +:summary: This guide explains how to leverage SmallRye GraphQL to implement GraphQL services. This guide demonstrates how your Quarkus application can use https://github.com/smallrye/smallrye-graphql/[SmallRye GraphQL], an implementation of the https://github.com/eclipse/microprofile-graphql/[MicroProfile GraphQL] specification. diff --git a/docs/src/main/asciidoc/smallrye-health.adoc b/docs/src/main/asciidoc/smallrye-health.adoc index 46d843dd79539..ed5b983288f53 100644 --- a/docs/src/main/asciidoc/smallrye-health.adoc +++ b/docs/src/main/asciidoc/smallrye-health.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye Health - include::./attributes.adoc[] +:categories: observability +:summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Health extension. This guide demonstrates how your Quarkus application can use https://github.com/smallrye/smallrye-health/[SmallRye Health] an implementation of the https://github.com/eclipse/microprofile-health/[MicroProfile Health] specification. diff --git a/docs/src/main/asciidoc/smallrye-metrics.adoc b/docs/src/main/asciidoc/smallrye-metrics.adoc index 9324e141fb783..57a530ab93383 100644 --- a/docs/src/main/asciidoc/smallrye-metrics.adoc +++ b/docs/src/main/asciidoc/smallrye-metrics.adoc @@ -6,8 +6,9 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = SmallRye Metrics :extension-status: deprecated - include::./attributes.adoc[] +:categories: observability +:summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Metrics extension. The following guide demonstrates how a Quarkus application can use link:https://github.com/smallrye/smallrye-metrics/[SmallRye Metrics], an implementation of the link:https://github.com/eclipse/microprofile-metrics/[MicroProfile Metrics] specification. diff --git a/docs/src/main/asciidoc/software-transactional-memory.adoc b/docs/src/main/asciidoc/software-transactional-memory.adoc index cf4183514ceef..7ae692e5f606c 100644 --- a/docs/src/main/asciidoc/software-transactional-memory.adoc +++ b/docs/src/main/asciidoc/software-transactional-memory.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Software Transactional Memory in Quarkus - include::./attributes.adoc[] +:categories: data +:summary: This guides covers the usage of Software Transactional Memory (STM). :extension-status: preview Software Transactional Memory (STM) has been around in research environments since the late diff --git a/docs/src/main/asciidoc/spring-boot-properties.adoc b/docs/src/main/asciidoc/spring-boot-properties.adoc index 7ef9aa3ab6fce..4a72b187f80bc 100644 --- a/docs/src/main/asciidoc/spring-boot-properties.adoc +++ b/docs/src/main/asciidoc/spring-boot-properties.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Accessing application properties with Spring Boot properties API - include::./attributes.adoc[] +:categories: compatibility +:summary: Use Spring Boot's `@ConfigurationProperties` in place of MicroProfile Config annotations If you prefer to use Spring Boot `@ConfigurationProperties` annotated class to access application properties instead of <> or a MicroProfile `@ConfigProperty` approach, you can do that with this extension. diff --git a/docs/src/main/asciidoc/spring-cache.adoc b/docs/src/main/asciidoc/spring-cache.adoc index 149220db0cb7d..712a10e5fc335 100644 --- a/docs/src/main/asciidoc/spring-cache.adoc +++ b/docs/src/main/asciidoc/spring-cache.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension for Spring Cache API - include::./attributes.adoc[] +:categories: compatibility +:summary: While you are encouraged to use the Cache extension for your application-level caching, Quarkus provides a compatibility layer for Spring Cache in the form of the spring-cache extension. While users are encouraged to use xref:cache.adoc[Quarkus annotations for caching], Quarkus nevertheless provides a compatibility layer for Spring Cache annotations in the form of the `spring-cache` extension. diff --git a/docs/src/main/asciidoc/spring-cloud-config-client.adoc b/docs/src/main/asciidoc/spring-cloud-config-client.adoc index bfc186dc9f906..7e5f9c232cab1 100644 --- a/docs/src/main/asciidoc/spring-cloud-config-client.adoc +++ b/docs/src/main/asciidoc/spring-cloud-config-client.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Reading properties from Spring Cloud Config Server - include::./attributes.adoc[] +:categories: compatibility +:summary: Quarkus provides a compatibility layer for Spring Cloud Config in the form of the spring-cloud-config-client extension. This guide explains how your Quarkus application can read configuration properties at runtime from the https://cloud.spring.io/spring-cloud-config[Spring Cloud Config Server]. diff --git a/docs/src/main/asciidoc/spring-data-jpa.adoc b/docs/src/main/asciidoc/spring-data-jpa.adoc index 9f9bd5728fbbf..81c41ecc12b5a 100644 --- a/docs/src/main/asciidoc/spring-data-jpa.adoc +++ b/docs/src/main/asciidoc/spring-data-jpa.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extension for Spring Data API - include::./attributes.adoc[] +:categories: compatibility +:summary: While you are encouraged to use Hibernate ORM with Panache for your data layer, Quarkus provides a compatibility layer for Spring Data JPA in the form of the spring-data-jpa extension. While users are encouraged to use Hibernate ORM with Panache for Relational Database access, Quarkus provides a compatibility layer for Spring Data JPA repositories in the form of the `spring-data-jpa` extension. diff --git a/docs/src/main/asciidoc/spring-data-rest.adoc b/docs/src/main/asciidoc/spring-data-rest.adoc index cf304afd015a9..de693259eccd9 100644 --- a/docs/src/main/asciidoc/spring-data-rest.adoc +++ b/docs/src/main/asciidoc/spring-data-rest.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extension for Spring Data REST - include::./attributes.adoc[] +:categories: compatibility +:summary: Spring Data REST simplifies the creation of CRUD applications based on our Spring Data compatibility layer. :extension-status: preview While users are encouraged to use REST Data with Panache for the REST data access endpoints generation, diff --git a/docs/src/main/asciidoc/spring-di.adoc b/docs/src/main/asciidoc/spring-di.adoc index bfccce294f93d..ff217395422a8 100644 --- a/docs/src/main/asciidoc/spring-di.adoc +++ b/docs/src/main/asciidoc/spring-di.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension for Spring DI API - include::./attributes.adoc[] +:categories: compatibility +:summary: While you are encouraged to use CDI annotations for injection, Quarkus provides a compatibility layer for Spring dependency injection in the form of the spring-di extension. While users are encouraged to use CDI annotations for injection, Quarkus provides a compatibility layer for Spring dependency injection in the form of the `spring-di` extension. diff --git a/docs/src/main/asciidoc/spring-scheduled.adoc b/docs/src/main/asciidoc/spring-scheduled.adoc index 033a2f7df40d8..a1ebb1b7813b9 100644 --- a/docs/src/main/asciidoc/spring-scheduled.adoc +++ b/docs/src/main/asciidoc/spring-scheduled.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension for Spring Scheduling API - include::./attributes.adoc[] +:categories: compatibility +:summary: While you are encouraged to use the Scheduler or Quartz extensions to schedule tasks, Quarkus provides a compatibility layer for Spring Scheduled in the form of the spring-scheduled extension. While users are encouraged to use xref:scheduler.adoc#standard-scheduling[regular Quarkus scheduler], Quarkus provides a compatibility layer for Spring Scheduled in the form of the `spring-scheduled` extension. diff --git a/docs/src/main/asciidoc/spring-security.adoc b/docs/src/main/asciidoc/spring-security.adoc index 915d6530a9b15..3ca8b59de9718 100644 --- a/docs/src/main/asciidoc/spring-security.adoc +++ b/docs/src/main/asciidoc/spring-security.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension for Spring Security API - include::./attributes.adoc[] +:categories: compatibility +:summary: While you are encouraged to use the Quarkus security layer to secure your applications, Quarkus provides a compatibility layer for Spring Security in the form of the spring-security extension. While users are encouraged to use xref:security.adoc#standard-security-annotations[Java standard annotations for security authorizations], Quarkus provides a compatibility layer for Spring Security in the form of the `spring-security` extension. diff --git a/docs/src/main/asciidoc/spring-web.adoc b/docs/src/main/asciidoc/spring-web.adoc index 98d91559e84fc..d0279f7b9accb 100644 --- a/docs/src/main/asciidoc/spring-web.adoc +++ b/docs/src/main/asciidoc/spring-web.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension for Spring Web API - include::./attributes.adoc[] +:categories: compatibility +:summary: While you are encouraged to use JAX-RS annotations for defining REST endpoints, Quarkus provides a compatibility layer for Spring Web in the form of the spring-web extension. While users are encouraged to use JAX-RS annotation for defining REST endpoints, Quarkus provides a compatibility layer for Spring Web in the form of the `spring-web` extension. diff --git a/docs/src/main/asciidoc/tests-with-coverage.adoc b/docs/src/main/asciidoc/tests-with-coverage.adoc index 915ebb29606b0..9091ae4140d32 100644 --- a/docs/src/main/asciidoc/tests-with-coverage.adoc +++ b/docs/src/main/asciidoc/tests-with-coverage.adoc @@ -5,9 +5,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Measuring the coverage of your tests - include::./attributes.adoc[] - +:categories: tooling +:summary: This guide explains how to measure the test coverage of your Quarkus application. :toc: macro :toclevels: 4 :doctype: book diff --git a/docs/src/main/asciidoc/tooling.adoc b/docs/src/main/asciidoc/tooling.adoc index a5723afdb8929..1796ef60de78b 100644 --- a/docs/src/main/asciidoc/tooling.adoc +++ b/docs/src/main/asciidoc/tooling.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using our Tooling - include::./attributes.adoc[] +:categories: getting-started +:summary: Explore the Quarkus developer toolchain which makes Quarkus development so fast and enjoyable. Quarkus comes with a toolchain enabling developers from live reload all the way down to deploying a Kubernetes application. In addition, there are plugins and extensions to all major IDEs. diff --git a/docs/src/main/asciidoc/transaction.adoc b/docs/src/main/asciidoc/transaction.adoc index 40628d9568bae..64ad9f91688d2 100644 --- a/docs/src/main/asciidoc/transaction.adoc +++ b/docs/src/main/asciidoc/transaction.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Transactions in Quarkus - include::./attributes.adoc[] +:categories: data +:summary: Quarkus comes with a Transaction Manager and uses it to coordinate and expose transactions to your applications. Each extension dealing with persistence will integrate with it for you, and you will explicitly interact with transactions via CDI. This guide will walk you through all that. Quarkus comes with a Transaction Manager and uses it to coordinate and expose transactions to your applications. Each extension dealing with persistence will integrate with it for you. diff --git a/docs/src/main/asciidoc/validation.adoc b/docs/src/main/asciidoc/validation.adoc index a9b27db888076..fda8cac26c4e2 100644 --- a/docs/src/main/asciidoc/validation.adoc +++ b/docs/src/main/asciidoc/validation.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Validation with Hibernate Validator - include::./attributes.adoc[] +:categories: web, data +:summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services. This guide covers how to use Hibernate Validator/Bean Validation for: diff --git a/docs/src/main/asciidoc/vertx-reference.adoc b/docs/src/main/asciidoc/vertx-reference.adoc index 337c5d266d65c..6737fd1ceac07 100644 --- a/docs/src/main/asciidoc/vertx-reference.adoc +++ b/docs/src/main/asciidoc/vertx-reference.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Vert.x Reference Guide - include::./attributes.adoc[] +:categories: miscellaneous +:summary: This reference guide provides advanced details about the usage and the configuration of the Vert.x instance used by Quarkus. https://vertx.io[Vert.x] is a toolkit for building reactive applications. As described in the xref:quarkus-reactive-architecture.adoc[Quarkus Reactive Architecture], Quarkus uses Vert.x underneath. diff --git a/docs/src/main/asciidoc/vertx.adoc b/docs/src/main/asciidoc/vertx.adoc index f1804c09ee6c2..635c94fb0d800 100644 --- a/docs/src/main/asciidoc/vertx.adoc +++ b/docs/src/main/asciidoc/vertx.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Eclipse Vert.x API from a Quarkus Application - include::./attributes.adoc[] +:categories: miscellaneous +:summary: This guide explains how to use Vert.x in Quarkus to build reactive applications. https://vertx.io[Vert.x] is a toolkit for building reactive applications. As described in the xref:quarkus-reactive-architecture.adoc[Quarkus Reactive Architecture], Quarkus uses Vert.x underneath. diff --git a/docs/src/main/asciidoc/websockets.adoc b/docs/src/main/asciidoc/websockets.adoc index fdc7149acd516..43070e66356a2 100644 --- a/docs/src/main/asciidoc/websockets.adoc +++ b/docs/src/main/asciidoc/websockets.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using WebSockets - include::./attributes.adoc[] +:categories: web +:summary: This guide explains how your Quarkus application can utilize web sockets to create interactive web applications. Because it’s the canonical web socket application, we are going to create a simple chat application. This guide explains how your Quarkus application can utilize web sockets to create interactive web applications. Because it's the _canonical_ web socket application, we are going to create a simple chat application. diff --git a/docs/src/main/asciidoc/writing-extensions.adoc b/docs/src/main/asciidoc/writing-extensions.adoc index 583f6a81c84c9..d1c07c628ad9a 100644 --- a/docs/src/main/asciidoc/writing-extensions.adoc +++ b/docs/src/main/asciidoc/writing-extensions.adoc @@ -4,7 +4,8 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Writing Your Own Extension - +:categories: writing-extensions +:summary: Quarkus extensions optimize your applications by pushing as much work as possible to the build operation. This guide explains the rationale of Quarkus extensions and guides you through authoring your own extensions. :numbered: :sectnums: :sectnumlevels: 4 diff --git a/docs/src/main/asciidoc/writing-native-applications-tips.adoc b/docs/src/main/asciidoc/writing-native-applications-tips.adoc index 6a083919f3465..95d602083804f 100644 --- a/docs/src/main/asciidoc/writing-native-applications-tips.adoc +++ b/docs/src/main/asciidoc/writing-native-applications-tips.adoc @@ -4,8 +4,9 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Tips for writing native applications - include::./attributes.adoc[] +:categories: core, writing-extensions +:summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable. This guide contains various tips and tricks for getting around problems that might arise when attempting to run Java applications as native executables.