Merge pull request quarkusio#28523 from nderwin-forks/feature/doc-sum…

…maries Added category and summary metadata to documentation files
gsmet · Oct 13, 2022 · 5ff8334 · 5ff8334
2 parents 1064654 + 0bfb83f
commit 5ff8334
Show file tree

Hide file tree

Showing 158 changed files with 318 additions and 160 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.
+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
@@ -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
@@ -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
@@ -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
 <<additional-information,Additional Information>> section.

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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: