diff --git a/docs/pom.xml b/docs/pom.xml index 3d5ff92ef83b8..79b0da9db78a0 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -2805,14 +2805,14 @@ src/main/asciidoc false - **/attributes.adoc + **/_attributes.adoc src/main/asciidoc true - **/attributes.adoc + **/_attributes.adoc @@ -2946,8 +2946,8 @@ true diff --git a/docs/src/main/asciidoc/0-glossary.adoc b/docs/src/main/asciidoc/0-glossary.adoc deleted file mode 100644 index 259e309503e0c..0000000000000 --- a/docs/src/main/asciidoc/0-glossary.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= Glossary - -include::./attributes.adoc[] - -This is a collection of preferred term in the documentation and website. -Please stay within these terms for consistency. - -* Live coding:: for our `quarkus:dev` capability -* GraalVM native image:: preferred term for the VM creating native executable. No space. -* Substrate VM:: non-preferred. Exclude. -* Native Executable:: the executable that is compiled to native 1s and 0s -* Docker image:: for the actual `Dockerfile` definition and when the tool chain is involved -* Container:: when we discuss Quarkus running in... containers -* Supersonic Subatomic Java:: our tagline -* Kubernetes Native Java:: our preferred tagline to say that we rock for containers -* Developer Joy:: for everything going from live reload to the opinionated layer to a single config file -* Unify Imperative and Reactive:: imperative and reactive. 'Nuff said. -* Best of breed frameworks and standards:: when we explain our stack diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index eff30d2cb0865..fd2112ac06476 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -1,5 +1,5 @@ = README: Quarkus documentation -include::attributes.adoc[] +include::_attributes.adoc[] Quarkus documentation uses asciidoc syntax. @@ -10,3 +10,20 @@ For more information on contributing to Quarkus docs, see: - xref:doc-contribute-docs-howto.adoc[How to contribute documentation] - xref:doc-concepts.adoc[Quarkus documentation concepts] - xref:doc-reference.adoc[Quarkus documentation reference] + +== Glossary + +This is a collection of preferred term in the documentation and website. +Please stay within these terms for consistency. + +* Live coding:: for our `quarkus:dev` capability +* GraalVM native image:: preferred term for the VM creating native executable. No space. +* Substrate VM:: non-preferred. Exclude. +* Native Executable:: the executable that is compiled to native 1s and 0s +* Docker image:: for the actual `Dockerfile` definition and when the tool chain is involved +* Container:: when we discuss Quarkus running in... containers +* Supersonic Subatomic Java:: our tagline +* Kubernetes Native Java:: our preferred tagline to say that we rock for containers +* Developer Joy:: for everything going from live reload to the opinionated layer to a single config file +* Unify Imperative and Reactive:: imperative and reactive. 'Nuff said. +* Best of breed frameworks and standards:: when we explain our stack diff --git a/docs/src/main/asciidoc/attributes-local.adoc b/docs/src/main/asciidoc/_attributes-local.adoc similarity index 95% rename from docs/src/main/asciidoc/attributes-local.adoc rename to docs/src/main/asciidoc/_attributes-local.adoc index 01c742337cd96..0f530d6c0e4ae 100644 --- a/docs/src/main/asciidoc/attributes-local.adoc +++ b/docs/src/main/asciidoc/_attributes-local.adoc @@ -9,5 +9,5 @@ :doc-examples: ./_examples :generated-dir: ../../../../target/asciidoc/generated :imagesdir: ./images -:includes: ./includes +:includes: ./_includes :toc: preamble diff --git a/docs/src/main/asciidoc/attributes.adoc b/docs/src/main/asciidoc/_attributes.adoc similarity index 98% rename from docs/src/main/asciidoc/attributes.adoc rename to docs/src/main/asciidoc/_attributes.adoc index 92b33e79b1921..eb2731f47aa63 100644 --- a/docs/src/main/asciidoc/attributes.adoc +++ b/docs/src/main/asciidoc/_attributes.adoc @@ -1,4 +1,3 @@ -<<<<<<< HEAD :project-name: Quarkus :quarkus-version: ${project.version} @@ -50,4 +49,4 @@ :vault-datasource-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/vault-datasource.html :micrometer-registry-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-micrometer-registry/dev/index.html -include::./attributes-local.adoc[] +include::_attributes-local.adoc[] diff --git a/docs/src/main/asciidoc/_examples/attributes.adoc b/docs/src/main/asciidoc/_examples/_attributes.adoc similarity index 100% rename from docs/src/main/asciidoc/_examples/attributes.adoc rename to docs/src/main/asciidoc/_examples/_attributes.adoc diff --git a/docs/src/main/asciidoc/includes/compile-quarkus-quickly.adoc b/docs/src/main/asciidoc/_includes/compile-quarkus-quickly.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/compile-quarkus-quickly.adoc rename to docs/src/main/asciidoc/_includes/compile-quarkus-quickly.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/build-native-container-parameters.adoc b/docs/src/main/asciidoc/_includes/devtools/build-native-container-parameters.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/build-native-container-parameters.adoc rename to docs/src/main/asciidoc/_includes/devtools/build-native-container-parameters.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/build-native-container.adoc b/docs/src/main/asciidoc/_includes/devtools/build-native-container.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/build-native-container.adoc rename to docs/src/main/asciidoc/_includes/devtools/build-native-container.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/build-native.adoc b/docs/src/main/asciidoc/_includes/devtools/build-native.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/build-native.adoc rename to docs/src/main/asciidoc/_includes/devtools/build-native.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/build.adoc b/docs/src/main/asciidoc/_includes/devtools/build.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/build.adoc rename to docs/src/main/asciidoc/_includes/devtools/build.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/create-app.adoc b/docs/src/main/asciidoc/_includes/devtools/create-app.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/create-app.adoc rename to docs/src/main/asciidoc/_includes/devtools/create-app.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/create-cli.adoc b/docs/src/main/asciidoc/_includes/devtools/create-cli.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/create-cli.adoc rename to docs/src/main/asciidoc/_includes/devtools/create-cli.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/dev-parameters.adoc b/docs/src/main/asciidoc/_includes/devtools/dev-parameters.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/dev-parameters.adoc rename to docs/src/main/asciidoc/_includes/devtools/dev-parameters.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/dev.adoc b/docs/src/main/asciidoc/_includes/devtools/dev.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/dev.adoc rename to docs/src/main/asciidoc/_includes/devtools/dev.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/extension-add.adoc b/docs/src/main/asciidoc/_includes/devtools/extension-add.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/extension-add.adoc rename to docs/src/main/asciidoc/_includes/devtools/extension-add.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/extension-list.adoc b/docs/src/main/asciidoc/_includes/devtools/extension-list.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/extension-list.adoc rename to docs/src/main/asciidoc/_includes/devtools/extension-list.adoc diff --git a/docs/src/main/asciidoc/includes/devtools/test.adoc b/docs/src/main/asciidoc/_includes/devtools/test.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/devtools/test.adoc rename to docs/src/main/asciidoc/_includes/devtools/test.adoc diff --git a/docs/src/main/asciidoc/duration-format-note.adoc b/docs/src/main/asciidoc/_includes/duration-format-note.adoc similarity index 100% rename from docs/src/main/asciidoc/duration-format-note.adoc rename to docs/src/main/asciidoc/_includes/duration-format-note.adoc diff --git a/docs/src/main/asciidoc/includes/extension-status.adoc b/docs/src/main/asciidoc/_includes/extension-status.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/extension-status.adoc rename to docs/src/main/asciidoc/_includes/extension-status.adoc diff --git a/docs/src/main/asciidoc/kogito-dev-services-build-time-config.adoc b/docs/src/main/asciidoc/_includes/kogito-dev-services-build-time-config.adoc similarity index 100% rename from docs/src/main/asciidoc/kogito-dev-services-build-time-config.adoc rename to docs/src/main/asciidoc/_includes/kogito-dev-services-build-time-config.adoc diff --git a/docs/src/main/asciidoc/platform-include.adoc b/docs/src/main/asciidoc/_includes/platform-include.adoc similarity index 100% rename from docs/src/main/asciidoc/platform-include.adoc rename to docs/src/main/asciidoc/_includes/platform-include.adoc diff --git a/docs/src/main/asciidoc/includes/prerequisites.adoc b/docs/src/main/asciidoc/_includes/prerequisites.adoc similarity index 100% rename from docs/src/main/asciidoc/includes/prerequisites.adoc rename to docs/src/main/asciidoc/_includes/prerequisites.adoc diff --git a/docs/src/main/asciidoc/quarkus-blaze-persistence.adoc b/docs/src/main/asciidoc/_includes/quarkus-blaze-persistence.adoc similarity index 100% rename from docs/src/main/asciidoc/quarkus-blaze-persistence.adoc rename to docs/src/main/asciidoc/_includes/quarkus-blaze-persistence.adoc diff --git a/docs/src/main/asciidoc/smallrye-kafka-incoming.adoc b/docs/src/main/asciidoc/_includes/smallrye-kafka-incoming.adoc similarity index 100% rename from docs/src/main/asciidoc/smallrye-kafka-incoming.adoc rename to docs/src/main/asciidoc/_includes/smallrye-kafka-incoming.adoc diff --git a/docs/src/main/asciidoc/smallrye-kafka-outgoing.adoc b/docs/src/main/asciidoc/_includes/smallrye-kafka-outgoing.adoc similarity index 100% rename from docs/src/main/asciidoc/smallrye-kafka-outgoing.adoc rename to docs/src/main/asciidoc/_includes/smallrye-kafka-outgoing.adoc diff --git a/docs/src/main/asciidoc/_templates/attributes.adoc b/docs/src/main/asciidoc/_templates/_attributes.adoc similarity index 100% rename from docs/src/main/asciidoc/_templates/attributes.adoc rename to docs/src/main/asciidoc/_templates/_attributes.adoc diff --git a/docs/src/main/asciidoc/_templates/template-concepts.adoc b/docs/src/main/asciidoc/_templates/template-concepts.adoc index 786bfc891ff58..d55462cce798e 100644 --- a/docs/src/main/asciidoc/_templates/template-concepts.adoc +++ b/docs/src/main/asciidoc/_templates/template-concepts.adoc @@ -9,7 +9,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc TODO: If this is a concept related to an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete) :extension-status: preview //// -include::attributes.adoc[] +include::_attributes.adoc[] A short introduction that summarizes or frames the concept. This summary should help a reader determine whether or not this document is what they want to read. diff --git a/docs/src/main/asciidoc/_templates/template-howto.adoc b/docs/src/main/asciidoc/_templates/template-howto.adoc index a4aa0e3b2d0ed..f0cdfeaf7f3b6 100644 --- a/docs/src/main/asciidoc/_templates/template-howto.adoc +++ b/docs/src/main/asciidoc/_templates/template-howto.adoc @@ -12,7 +12,7 @@ TODO: Title should have an implied "How to.." in front. See TODO: If this is a reference for an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete) :extension-status: preview //// -include::attributes.adoc[] +include::_attributes.adoc[] How-to guides are goal-oriented, and should help the reader accomplish a task (where there may be forks in the path). diff --git a/docs/src/main/asciidoc/_templates/template-reference.adoc b/docs/src/main/asciidoc/_templates/template-reference.adoc index ffa6bb2af364c..c1774c9fb48ba 100644 --- a/docs/src/main/asciidoc/_templates/template-reference.adoc +++ b/docs/src/main/asciidoc/_templates/template-reference.adoc @@ -9,7 +9,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc TODO: If this is a reference for an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete) :extension-status: preview //// -include::attributes.adoc[] +include::_attributes.adoc[] A short introduction that describes the content of this reference. This summary should help a reader determine if this document is likely to contain the information they are looking for. diff --git a/docs/src/main/asciidoc/_templates/template-tutorial.adoc b/docs/src/main/asciidoc/_templates/template-tutorial.adoc index d89f08a481d08..e71c3cedc5974 100644 --- a/docs/src/main/asciidoc/_templates/template-tutorial.adoc +++ b/docs/src/main/asciidoc/_templates/template-tutorial.adoc @@ -9,7 +9,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc TODO: If this is a tutorial for an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete) :extension-status: preview //// -include::attributes.adoc[] +include::_attributes.adoc[] Describe what the learner will accomplish (examples: build, create, construct, deploy; not: “you will learn...”). This short summary should help a reader determine if they want to engage with the content. diff --git a/docs/src/main/asciidoc/all-builditems.adoc b/docs/src/main/asciidoc/all-builditems.adoc index a409c1fe958d2..37d6431639e6c 100644 --- a/docs/src/main/asciidoc/all-builditems.adoc +++ b/docs/src/main/asciidoc/all-builditems.adoc @@ -7,7 +7,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Build Items -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: writing-extensions :summary: Explore all the BuildItems you can consume/produce in your extensions. diff --git a/docs/src/main/asciidoc/all-config.adoc b/docs/src/main/asciidoc/all-config.adoc index 42c8b12f11336..4a97e523641ae 100644 --- a/docs/src/main/asciidoc/all-config.adoc +++ b/docs/src/main/asciidoc/all-config.adoc @@ -7,7 +7,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = All configuration options -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: List all the configuration properties per extensions diff --git a/docs/src/main/asciidoc/amazon-credentials.adoc b/docs/src/main/asciidoc/amazon-credentials.adoc deleted file mode 100644 index 409f9fbdec505..0000000000000 --- a/docs/src/main/asciidoc/amazon-credentials.adoc +++ /dev/null @@ -1,5 +0,0 @@ -* Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` -* Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` -* Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI -* Credentials delivered through the Amazon ECS if the `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and the security manager has permission to access the variable, -* Instance profile credentials delivered through the Amazon EC2 metadata service \ No newline at end of file diff --git a/docs/src/main/asciidoc/amazon-lambda-http.adoc b/docs/src/main/asciidoc/amazon-lambda-http.adoc index 81c2d3e55dae5..54eabe4e09d98 100644 --- a/docs/src/main/asciidoc/amazon-lambda-http.adoc +++ b/docs/src/main/asciidoc/amazon-lambda-http.adoc @@ -5,7 +5,7 @@ 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[] +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: diff --git a/docs/src/main/asciidoc/amazon-lambda.adoc b/docs/src/main/asciidoc/amazon-lambda.adoc index 9768bb9f7d9db..9ff4f289e4ac8 100644 --- a/docs/src/main/asciidoc/amazon-lambda.adoc +++ b/docs/src/main/asciidoc/amazon-lambda.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Amazon Lambda -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains how you can deploy Quarkus-based Amazon Lambdas. diff --git a/docs/src/main/asciidoc/amqp-dev-services.adoc b/docs/src/main/asciidoc/amqp-dev-services.adoc index 34b884f3160e4..87a025a5797bd 100644 --- a/docs/src/main/asciidoc/amqp-dev-services.adoc +++ b/docs/src/main/asciidoc/amqp-dev-services.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: Start AMQP automatically in dev and test modes. diff --git a/docs/src/main/asciidoc/amqp-reference.adoc b/docs/src/main/asciidoc/amqp-reference.adoc index e2b3a75791717..5e2c683308667 100644 --- a/docs/src/main/asciidoc/amqp-reference.adoc +++ b/docs/src/main/asciidoc/amqp-reference.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Reactive Messaging AMQP 1.0 Connector Reference Documentation -include::./attributes.adoc[] +include::_attributes.adoc[] This guide is the companion from the xref:amqp.adoc[Getting Started with AMQP 1.0]. It explains in more details the configuration and usage of the AMQP connector for reactive messaging. diff --git a/docs/src/main/asciidoc/amqp.adoc b/docs/src/main/asciidoc/amqp.adoc index a692acf53db49..99cce7e9d1bdb 100644 --- a/docs/src/main/asciidoc/amqp.adoc +++ b/docs/src/main/asciidoc/amqp.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with AMQP. diff --git a/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc b/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc index 7ca82d5031d27..cc6020d803a17 100644 --- a/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc +++ b/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: Start Apicurio Registry automatically in dev and test modes. diff --git a/docs/src/main/asciidoc/azure-functions-http.adoc b/docs/src/main/asciidoc/azure-functions-http.adoc index 3744f2748f9b7..e289cbd98b8ca 100644 --- a/docs/src/main/asciidoc/azure-functions-http.adoc +++ b/docs/src/main/asciidoc/azure-functions-http.adoc @@ -5,7 +5,7 @@ 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[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an Azure Function. diff --git a/docs/src/main/asciidoc/blaze-persistence.adoc b/docs/src/main/asciidoc/blaze-persistence.adoc index bcdd5f95f1538..0c6cc49bfe0bb 100644 --- a/docs/src/main/asciidoc/blaze-persistence.adoc +++ b/docs/src/main/asciidoc/blaze-persistence.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Blaze-Persistence -include::./attributes.adoc[] +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 @@ -17,7 +17,7 @@ queries which are then transformed to optimized queries that only fetch the data The same DTO definitions can further be used for applying database updates, leading to a great reduction in boilerplate code and removing the need for object mapping tools. -include::./platform-include.adoc[] +include::{includes}/platform-include.adoc[] == Setting up and configuring Blaze-Persistence @@ -223,7 +223,7 @@ When no property is set, the Blaze-Persistence defaults apply. The configuration properties listed here allow you to override such defaults, and customize and tune various aspects. -include::quarkus-blaze-persistence.adoc[opts=optional, leveloffset=+2] +include::{includes}/quarkus-blaze-persistence.adoc[opts=optional, leveloffset=+2] Apart from these configuration options, further configuration and customization can be applied by observing a `CriteriaBuilderConfiguration` or `EntityViewConfiguration` events and applying customizations on these objects. The various customization use cases can be found in the link:https://persistence.blazebit.com/documentation/entity-view/manual/en_US/index.html#quarkus-customization[Quarkus section of the entity-view documentation]. diff --git a/docs/src/main/asciidoc/building-my-first-extension.adoc b/docs/src/main/asciidoc/building-my-first-extension.adoc index 7b3dd527ff77c..fa8790d26b174 100644 --- a/docs/src/main/asciidoc/building-my-first-extension.adoc +++ b/docs/src/main/asciidoc/building-my-first-extension.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: writing-extensions :summary: Learn step by step how to build a simple extension. diff --git a/docs/src/main/asciidoc/building-native-image.adoc b/docs/src/main/asciidoc/building-native-image.adoc index ddad7f9d25b49..9ef4d63b524ec 100644 --- a/docs/src/main/asciidoc/building-native-image.adoc +++ b/docs/src/main/asciidoc/building-native-image.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: getting-started :summary: Build native executables with GraalVM or Mandrel. diff --git a/docs/src/main/asciidoc/cache.adoc b/docs/src/main/asciidoc/cache.adoc index e641a73975b1a..b1dc8081d4508 100644 --- a/docs/src/main/asciidoc/cache.adoc +++ b/docs/src/main/asciidoc/cache.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Application Data Caching :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: data :summary: This guide explains how to cache expensive method calls of your CDI beans using simple annotations. diff --git a/docs/src/main/asciidoc/camel.adoc b/docs/src/main/asciidoc/camel.adoc index e038e23f52767..23342f625f202 100644 --- a/docs/src/main/asciidoc/camel.adoc +++ b/docs/src/main/asciidoc/camel.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: integration :summary: This guide covers the systems integration with Apache Camel diff --git a/docs/src/main/asciidoc/capabilities.adoc b/docs/src/main/asciidoc/capabilities.adoc index 251193021c59f..d98bef7068689 100644 --- a/docs/src/main/asciidoc/capabilities.adoc +++ b/docs/src/main/asciidoc/capabilities.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extension Capabilities -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: writing-extensions :summary: How capabilities are implemented and used in Quarkus. diff --git a/docs/src/main/asciidoc/cassandra.adoc b/docs/src/main/asciidoc/cassandra.adoc index 0429e0e9e913c..9fe0090191a37 100644 --- a/docs/src/main/asciidoc/cassandra.adoc +++ b/docs/src/main/asciidoc/cassandra.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: data :summary: This guide covers how to use the Apache Cassandra NoSQL database in Quarkus. @@ -14,7 +14,7 @@ high availability with no single point of failure. In this guide, we will see how you can get your REST services to use a Cassandra database. -include::./platform-include.adoc[] +include::{includes}/platform-include.adoc[] == Prerequisites diff --git a/docs/src/main/asciidoc/cdi-integration.adoc b/docs/src/main/asciidoc/cdi-integration.adoc index 65f4a7d693487..8be356cfb891f 100644 --- a/docs/src/main/asciidoc/cdi-integration.adoc +++ b/docs/src/main/asciidoc/cdi-integration.adoc @@ -6,7 +6,7 @@ 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[] +include::_attributes.adoc[] :numbered: :toc: :toclevels: 2 diff --git a/docs/src/main/asciidoc/cdi-reference.adoc b/docs/src/main/asciidoc/cdi-reference.adoc index 3485d80b15d6b..ed815f0691f39 100644 --- a/docs/src/main/asciidoc/cdi-reference.adoc +++ b/docs/src/main/asciidoc/cdi-reference.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: core :summary: Go more in depth into the Quarkus implementation of CDI. :numbered: diff --git a/docs/src/main/asciidoc/cdi.adoc b/docs/src/main/asciidoc/cdi.adoc index cb5ac76825050..15e3ba315fe78 100644 --- a/docs/src/main/asciidoc/cdi.adoc +++ b/docs/src/main/asciidoc/cdi.adoc @@ -4,7 +4,7 @@ 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[] +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: diff --git a/docs/src/main/asciidoc/centralized-log-management.adoc b/docs/src/main/asciidoc/centralized-log-management.adoc index 1df8b71cf4658..d274aa94355fd 100644 --- a/docs/src/main/asciidoc/centralized-log-management.adoc +++ b/docs/src/main/asciidoc/centralized-log-management.adoc @@ -4,7 +4,7 @@ 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[] +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). diff --git a/docs/src/main/asciidoc/class-loading-reference.adoc b/docs/src/main/asciidoc/class-loading-reference.adoc index 3ba476a4912c6..9bbe01b02a6d9 100644 --- a/docs/src/main/asciidoc/class-loading-reference.adoc +++ b/docs/src/main/asciidoc/class-loading-reference.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Class Loading Reference -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: architecture :summary: Learn more about Quarkus class loading infrastructure. diff --git a/docs/src/main/asciidoc/cli-tooling.adoc b/docs/src/main/asciidoc/cli-tooling.adoc index 43613cd54b276..6cd609cfc89df 100644 --- a/docs/src/main/asciidoc/cli-tooling.adoc +++ b/docs/src/main/asciidoc/cli-tooling.adoc @@ -5,7 +5,7 @@ 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[] +include::_attributes.adoc[] :categories: tooling :summary: Use the Quarkus CLI to create, build, run, and manage extensions for Quarkus projects. diff --git a/docs/src/main/asciidoc/command-mode-reference.adoc b/docs/src/main/asciidoc/command-mode-reference.adoc index 8d28d8c95fc56..73f2cbd46a499 100644 --- a/docs/src/main/asciidoc/command-mode-reference.adoc +++ b/docs/src/main/asciidoc/command-mode-reference.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Command Mode Applications -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core, command-line :summary: This reference guide explains how to develop command line applications with Quarkus. diff --git a/docs/src/main/asciidoc/conditional-extension-dependencies.adoc b/docs/src/main/asciidoc/conditional-extension-dependencies.adoc index 226e8350f8c0c..db3bbfad4c4e5 100644 --- a/docs/src/main/asciidoc/conditional-extension-dependencies.adoc +++ b/docs/src/main/asciidoc/conditional-extension-dependencies.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Conditional Extension Dependencies -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: writing-extensions :summary: Trigger the inclusion on additional extensions based on certain conditions. diff --git a/docs/src/main/asciidoc/config-extending-support.adoc b/docs/src/main/asciidoc/config-extending-support.adoc index 80eb149336b79..8a5428acd504b 100644 --- a/docs/src/main/asciidoc/config-extending-support.adoc +++ b/docs/src/main/asciidoc/config-extending-support.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extending Configuration Support -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: Extend and customize the Configuration. :numbered: diff --git a/docs/src/main/asciidoc/config-mappings.adoc b/docs/src/main/asciidoc/config-mappings.adoc index cb21c389f66d9..2fc05f451bcee 100644 --- a/docs/src/main/asciidoc/config-mappings.adoc +++ b/docs/src/main/asciidoc/config-mappings.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: core :summary: Group multiple configuration properties into an object. :numbered: diff --git a/docs/src/main/asciidoc/config-reference.adoc b/docs/src/main/asciidoc/config-reference.adoc index 615023c1d8341..a22a94d363fda 100644 --- a/docs/src/main/asciidoc/config-reference.adoc +++ b/docs/src/main/asciidoc/config-reference.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Configuration Reference Guide -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: Learn more about how to configure your Quarkus applications. :numbered: diff --git a/docs/src/main/asciidoc/config-yaml.adoc b/docs/src/main/asciidoc/config-yaml.adoc index 7265674064dcd..d2f46b965fd30 100644 --- a/docs/src/main/asciidoc/config-yaml.adoc +++ b/docs/src/main/asciidoc/config-yaml.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = YAML Configuration -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: YAML as a Configuration Source. :toc: diff --git a/docs/src/main/asciidoc/config.adoc b/docs/src/main/asciidoc/config.adoc index 9eed2c89e2fe8..bace61c263a95 100644 --- a/docs/src/main/asciidoc/config.adoc +++ b/docs/src/main/asciidoc/config.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Configuring Your Application -include::./attributes.adoc[] +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. diff --git a/docs/src/main/asciidoc/container-image.adoc b/docs/src/main/asciidoc/container-image.adoc index cbfc15f7bde50..4cedf318a0d6c 100644 --- a/docs/src/main/asciidoc/container-image.adoc +++ b/docs/src/main/asciidoc/container-image.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Container Images -include::./attributes.adoc[] +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. diff --git a/docs/src/main/asciidoc/context-propagation.adoc b/docs/src/main/asciidoc/context-propagation.adoc index 29e02a72045ba..49160acd57ebc 100644 --- a/docs/src/main/asciidoc/context-propagation.adoc +++ b/docs/src/main/asciidoc/context-propagation.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: core :summary: Learn more about how you can pass contextual information with SmallRye Context Propagation. diff --git a/docs/src/main/asciidoc/continuous-testing.adoc b/docs/src/main/asciidoc/continuous-testing.adoc index 17114e37744bd..820224edd2267 100644 --- a/docs/src/main/asciidoc/continuous-testing.adoc +++ b/docs/src/main/asciidoc/continuous-testing.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Continuous Testing -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: Get early test feedback with Continuous Testing. :toc: macro diff --git a/docs/src/main/asciidoc/credentials-provider.adoc b/docs/src/main/asciidoc/credentials-provider.adoc index d67dba88e8ca5..e37d833d8f304 100644 --- a/docs/src/main/asciidoc/credentials-provider.adoc +++ b/docs/src/main/asciidoc/credentials-provider.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/databases-dev-services.adoc b/docs/src/main/asciidoc/databases-dev-services.adoc index 9176c8d326a08..b2d6eb1cef735 100644 --- a/docs/src/main/asciidoc/databases-dev-services.adoc +++ b/docs/src/main/asciidoc/databases-dev-services.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for Databases -include::./attributes.adoc[] +include::_attributes.adoc[] When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services. Depending on your database type you may need Docker installed in order to use this feature. diff --git a/docs/src/main/asciidoc/datasource.adoc b/docs/src/main/asciidoc/datasource.adoc index ae91021cf9f20..3a92279a27440 100644 --- a/docs/src/main/asciidoc/datasource.adoc +++ b/docs/src/main/asciidoc/datasource.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Datasources -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: data :summary: With Quarkus, you can easily configure a datasource, or several if need be. diff --git a/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc b/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc index 3396eee0e0f33..e8f3f585bff04 100644 --- a/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc +++ b/docs/src/main/asciidoc/deploying-to-azure-cloud.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains how to deploy a Quarkus application to Microsoft Azure Cloud. diff --git a/docs/src/main/asciidoc/deploying-to-google-cloud.adoc b/docs/src/main/asciidoc/deploying-to-google-cloud.adoc index ff5cb3bc86934..1a1417fc45841 100644 --- a/docs/src/main/asciidoc/deploying-to-google-cloud.adoc +++ b/docs/src/main/asciidoc/deploying-to-google-cloud.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains how to deploy a Quarkus application to Google Cloud. diff --git a/docs/src/main/asciidoc/deploying-to-heroku.adoc b/docs/src/main/asciidoc/deploying-to-heroku.adoc index ec518db2572f6..d28be4ea8101f 100644 --- a/docs/src/main/asciidoc/deploying-to-heroku.adoc +++ b/docs/src/main/asciidoc/deploying-to-heroku.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Deploying to Heroku -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: Deploy your Quarkus applications on Heroku. diff --git a/docs/src/main/asciidoc/deploying-to-kubernetes.adoc b/docs/src/main/asciidoc/deploying-to-kubernetes.adoc index 4cca5da8445e9..06ad88d779995 100644 --- a/docs/src/main/asciidoc/deploying-to-kubernetes.adoc +++ b/docs/src/main/asciidoc/deploying-to-kubernetes.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Kubernetes extension -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide covers how to deploy a native application on Kubernetes. diff --git a/docs/src/main/asciidoc/deploying-to-openshift.adoc b/docs/src/main/asciidoc/deploying-to-openshift.adoc index 2851ff0c6eb4e..6ea9a89a95485 100644 --- a/docs/src/main/asciidoc/deploying-to-openshift.adoc +++ b/docs/src/main/asciidoc/deploying-to-openshift.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Deploying on OpenShift -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide covers how to deploy a native application on OpenShift. diff --git a/docs/src/main/asciidoc/dev-mode-differences.adoc b/docs/src/main/asciidoc/dev-mode-differences.adoc index a88ddc2e23f63..056598d83c02c 100644 --- a/docs/src/main/asciidoc/dev-mode-differences.adoc +++ b/docs/src/main/asciidoc/dev-mode-differences.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: architecture :summary: How dev mode differs from a production application diff --git a/docs/src/main/asciidoc/dev-services.adoc b/docs/src/main/asciidoc/dev-services.adoc index 14a166637e7db..eb8282f56dbcf 100644 --- a/docs/src/main/asciidoc/dev-services.adoc +++ b/docs/src/main/asciidoc/dev-services.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services Overview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: A list of all extensions that support Dev Services and their configuration options. @@ -79,7 +79,7 @@ include::{generated-dir}/config/quarkus-keycloak-devservices-keycloak-keycloak-b The Kogito Dev Service will be enabled when either `kogito-quarkus` or `kogito-quarkus-processes` extension is present in your application. More information can be found at the xref:kogito-dev-services.adoc[Kogito Dev Services Guide]. -include::kogito-dev-services-build-time-config.adoc[opts=optional, leveloffset=+1] +include::{includes}/kogito-dev-services-build-time-config.adoc[opts=optional, leveloffset=+1] == MongoDB diff --git a/docs/src/main/asciidoc/dev-ui.adoc b/docs/src/main/asciidoc/dev-ui.adoc index 479df7124b6fd..bcfe42cafe046 100644 --- a/docs/src/main/asciidoc/dev-ui.adoc +++ b/docs/src/main/asciidoc/dev-ui.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev UI -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: writing-extensions :summary: Learn how to get your extension contribute features to the Dev UI. diff --git a/docs/src/main/asciidoc/doc-concepts.adoc b/docs/src/main/asciidoc/doc-concepts.adoc index d2231846b6a98..339a93d347919 100644 --- a/docs/src/main/asciidoc/doc-concepts.adoc +++ b/docs/src/main/asciidoc/doc-concepts.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// [id="concepts-quarkus-documentation"] = Quarkus documentation concepts -include::attributes.adoc[] +include::_attributes.adoc[] :categories: contributing :fn-diataxis: footnote:diataxis[Procida, D. Diátaxis documentation framework. https://diataxis.fr/] diff --git a/docs/src/main/asciidoc/doc-contribute-docs-howto.adoc b/docs/src/main/asciidoc/doc-contribute-docs-howto.adoc index 33335d186c0a8..ad93106f4a153 100644 --- a/docs/src/main/asciidoc/doc-contribute-docs-howto.adoc +++ b/docs/src/main/asciidoc/doc-contribute-docs-howto.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// [id="howto-contribute-docs"] = How to contribute documentation -include::attributes.adoc[] +include::_attributes.adoc[] :categories: contributing :asciidoc: https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/ :quarkus-docs: {quarkus-base-url}/tree/main/docs diff --git a/docs/src/main/asciidoc/doc-create-tutorial.adoc b/docs/src/main/asciidoc/doc-create-tutorial.adoc index 6b09d78ba95ab..b37f07692b654 100644 --- a/docs/src/main/asciidoc/doc-create-tutorial.adoc +++ b/docs/src/main/asciidoc/doc-create-tutorial.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// [id="tutorial-doc-create-tutorial"] = Creating a tutorial -include::attributes.adoc[] +include::_attributes.adoc[] :categories: contributing Create a new tutorial that guides users through creating, running, and testing a Quarkus application that uses annotations from an imaginary extension. @@ -42,7 +42,7 @@ Copy `docs/src/main/diataxis/_templates/template-tutorial.adoc` from the Quarkus [id="tutorial-acme-serve-http-requests"] // <1> = Serve Http requests using the Acme extension // <2> :extension-status: experimental // <3> -include::attributes.adoc[] // <4> +include::_attributes.adoc[] // <4> ---- <1> Specify a unique id for the section in lower-kebab-case. diff --git a/docs/src/main/asciidoc/doc-reference.adoc b/docs/src/main/asciidoc/doc-reference.adoc index 58ed9c272ef9d..a7b08b3c6ac97 100644 --- a/docs/src/main/asciidoc/doc-reference.adoc +++ b/docs/src/main/asciidoc/doc-reference.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// [id="reference-doc-quarkus-documentation"] = About Quarkus documentation -include::attributes.adoc[] +include::_attributes.adoc[] :categories: contributing A detailed reference for the structure and composition of Quarkus documentation. @@ -134,7 +134,7 @@ For example, this document has the following in its header: ---- [id="reference-doc-quarkus-documentation"] = Quarkus documentation reference -\include::attributes.adoc[] +\include::_attributes.adoc[] :toc: preamble ---- diff --git a/docs/src/main/asciidoc/elasticsearch-dev-services.adoc b/docs/src/main/asciidoc/elasticsearch-dev-services.adoc index a9edd106ffa10..773c7f4754c29 100644 --- a/docs/src/main/asciidoc/elasticsearch-dev-services.adoc +++ b/docs/src/main/asciidoc/elasticsearch-dev-services.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for Elasticsearch -include::./attributes.adoc[] +include::_attributes.adoc[] If any Elasticsearch-related extension is present (e.g. `quarkus-elasticsearch-rest-client` or `quarkus-hibernate-search-orm-elasticsearch`), Dev Services for Elasticsearch automatically starts an Elasticsearch server in dev mode and when running tests. diff --git a/docs/src/main/asciidoc/elasticsearch.adoc b/docs/src/main/asciidoc/elasticsearch.adoc index 5225db7ea0246..45c9f8a840644 100644 --- a/docs/src/main/asciidoc/elasticsearch.adoc +++ b/docs/src/main/asciidoc/elasticsearch.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Connecting to an Elasticsearch cluster -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: data :summary: This guide covers how to use an Elasticsearch cluster using the low level or high level REST clients. diff --git a/docs/src/main/asciidoc/extension-codestart.adoc b/docs/src/main/asciidoc/extension-codestart.adoc index 22194aeb1ebf2..a5e9c573e4a85 100644 --- a/docs/src/main/asciidoc/extension-codestart.adoc +++ b/docs/src/main/asciidoc/extension-codestart.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Extension codestart -include::./attributes.adoc[] +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. diff --git a/docs/src/main/asciidoc/extension-metadata.adoc b/docs/src/main/asciidoc/extension-metadata.adoc index e817b842f04db..7eb5432a720f2 100644 --- a/docs/src/main/asciidoc/extension-metadata.adoc +++ b/docs/src/main/asciidoc/extension-metadata.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension Metadata -include::./attributes.adoc[] +include::_attributes.adoc[] Quarkus extensions are distributed as Maven JAR artifacts that application and other libraries may depend on. When a Quarkus application project is built, tested or edited using the Quarkus dev tools, Quarkus extension JAR artifacts will be identified on the application classpath by the presence of the Quarkus extension metadata files in them. This document describes the purpose of each Quarkus extension metadata file and its content. diff --git a/docs/src/main/asciidoc/extension-registry-user.adoc b/docs/src/main/asciidoc/extension-registry-user.adoc index 7496fe05057d1..6768fa06b2218 100644 --- a/docs/src/main/asciidoc/extension-registry-user.adoc +++ b/docs/src/main/asciidoc/extension-registry-user.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Extension Registry -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: architecture :summary: Learn more about the notion of extension registry and how you can use your own. diff --git a/docs/src/main/asciidoc/faq.adoc b/docs/src/main/asciidoc/faq.adoc deleted file mode 100644 index a7c9bbe4fe4d4..0000000000000 --- a/docs/src/main/asciidoc/faq.adoc +++ /dev/null @@ -1,29 +0,0 @@ -= Frequently Asked Questions - -include::./attributes.adoc[] - -:toc: macro -:toclevels: 4 -:doctype: book -:icons: font -:docinfo1: - -:numbered: -:sectnums: -:sectnumlevels: 4 - -== Native compilation - -Native executable fails on macOS with `error: unknown type name 'uint8_t'`:: -Your macOS has the wrong `*.h` files compared to the OS and no gcc compilation will work. -This can happen when you migrate from versions of the OS. -See https://stackoverflow.com/questions/48029309/cannot-compile-any-c-programs-error-unknown-type-name-uint8-t -+ -The solution is to - -* `sudo mv /usr/local/include /usr/local/include.old` -* Reinstall XCode for good measure -* (optional?) `brew install llvm` -* generally reinstall your brew dependencies with native compilation - -The executable should work now. diff --git a/docs/src/main/asciidoc/flyway.adoc b/docs/src/main/asciidoc/flyway.adoc index faeee0b253a06..e908197220b09 100644 --- a/docs/src/main/asciidoc/flyway.adoc +++ b/docs/src/main/asciidoc/flyway.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Flyway -include::./attributes.adoc[] +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 diff --git a/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc b/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc index 9a11f1748204a..374492621c7cc 100644 --- a/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc +++ b/docs/src/main/asciidoc/funqy-amazon-lambda-http.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy HTTP Binding with Amazon Lambda  :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains Funqy's Amazon Lambda HTTP binding. diff --git a/docs/src/main/asciidoc/funqy-amazon-lambda.adoc b/docs/src/main/asciidoc/funqy-amazon-lambda.adoc index 53c82d7090ec8..72e89b0ad7288 100644 --- a/docs/src/main/asciidoc/funqy-amazon-lambda.adoc +++ b/docs/src/main/asciidoc/funqy-amazon-lambda.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Funqy Amazon Lambda Binding :extension-status: preview :devtools-no-gradle: -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains Funqy's Amazon Lambda binding. diff --git a/docs/src/main/asciidoc/funqy-azure-functions-http.adoc b/docs/src/main/asciidoc/funqy-azure-functions-http.adoc index e6a458ee1571c..8f56fe28d4f45 100644 --- a/docs/src/main/asciidoc/funqy-azure-functions-http.adoc +++ b/docs/src/main/asciidoc/funqy-azure-functions-http.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy HTTP Binding with Azure Functions :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains Funqy's Azure Functions HTTP binding. diff --git a/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc b/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc index 9da8deb240dc1..271fe0da0d828 100644 --- a/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc +++ b/docs/src/main/asciidoc/funqy-gcp-functions-http.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy HTTP Binding with Google Cloud Functions :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains Funqy's Google Cloud Platform Functions HTTP binding. diff --git a/docs/src/main/asciidoc/funqy-gcp-functions.adoc b/docs/src/main/asciidoc/funqy-gcp-functions.adoc index 77b8250dcae22..61bd9b13b508a 100644 --- a/docs/src/main/asciidoc/funqy-gcp-functions.adoc +++ b/docs/src/main/asciidoc/funqy-gcp-functions.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy Google Cloud Functions :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains Funqy's Google Cloud Platform Functions binding. diff --git a/docs/src/main/asciidoc/funqy-http.adoc b/docs/src/main/asciidoc/funqy-http.adoc index df8f4f03c9368..059a3ec491da7 100644 --- a/docs/src/main/asciidoc/funqy-http.adoc +++ b/docs/src/main/asciidoc/funqy-http.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains Funqy's HTTP binding. :extension-status: preview diff --git a/docs/src/main/asciidoc/funqy-knative-events.adoc b/docs/src/main/asciidoc/funqy-knative-events.adoc index ff681baf397f5..ff2022e39b891 100644 --- a/docs/src/main/asciidoc/funqy-knative-events.adoc +++ b/docs/src/main/asciidoc/funqy-knative-events.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains Funqy's Knative Events binding. :extension-status: preview diff --git a/docs/src/main/asciidoc/funqy.adoc b/docs/src/main/asciidoc/funqy.adoc index 92ee0756e2c71..4e7403c59abd2 100644 --- a/docs/src/main/asciidoc/funqy.adoc +++ b/docs/src/main/asciidoc/funqy.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Funqy -include::./attributes.adoc[] +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 diff --git a/docs/src/main/asciidoc/gcp-functions-http.adoc b/docs/src/main/asciidoc/gcp-functions-http.adoc index b39ea679e2af0..fa7fb80c220d9 100644 --- a/docs/src/main/asciidoc/gcp-functions-http.adoc +++ b/docs/src/main/asciidoc/gcp-functions-http.adoc @@ -5,7 +5,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/gcp-functions.adoc b/docs/src/main/asciidoc/gcp-functions.adoc index c1e1dc54d26c9..293536ce2ee08 100644 --- a/docs/src/main/asciidoc/gcp-functions.adoc +++ b/docs/src/main/asciidoc/gcp-functions.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Google Cloud Functions (Serverless) :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide explains how you can deploy Quarkus-based Google Cloud Functions. diff --git a/docs/src/main/asciidoc/getting-started-reactive.adoc b/docs/src/main/asciidoc/getting-started-reactive.adoc index de6c3ddaae7b6..fead1e41e8c1f 100644 --- a/docs/src/main/asciidoc/getting-started-reactive.adoc +++ b/docs/src/main/asciidoc/getting-started-reactive.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: getting-started :summary: Learn more about developing reactive applications with Quarkus. diff --git a/docs/src/main/asciidoc/getting-started-testing.adoc b/docs/src/main/asciidoc/getting-started-testing.adoc index 4f3a682c68747..25f113351d51e 100644 --- a/docs/src/main/asciidoc/getting-started-testing.adoc +++ b/docs/src/main/asciidoc/getting-started-testing.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Testing Your Application -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: This guide covers testing in JVM mode, native mode, and injection of resources into tests :toc: macro diff --git a/docs/src/main/asciidoc/getting-started.adoc b/docs/src/main/asciidoc/getting-started.adoc index 753772fc82d39..57b17b3954466 100644 --- a/docs/src/main/asciidoc/getting-started.adoc +++ b/docs/src/main/asciidoc/getting-started.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Creating Your First Application -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: getting-started :summary: Discover how to create your first Quarkus application. :toc: macro diff --git a/docs/src/main/asciidoc/gradle-config.adoc b/docs/src/main/asciidoc/gradle-config.adoc deleted file mode 100644 index 198d686357209..0000000000000 --- a/docs/src/main/asciidoc/gradle-config.adoc +++ /dev/null @@ -1,49 +0,0 @@ -//// -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 -//// -= Gradle Plugin Repositories - -include::./attributes.adoc[] - -// tag::repositories[] -The Quarkus Gradle plugin is published to the https://plugins.gradle.org/plugin/io.quarkus[Gradle Plugin Portal]. - -To use it, add the following to your `build.gradle` file: - -[source, groovy, subs=attributes+] ----- -plugins { - id 'java' - id 'io.quarkus' -} ----- - -You also need to add the following at the top of your `settings.gradle` file: -[source, groovy, subs=attributes+] ----- -pluginManagement { - repositories { - mavenCentral() - gradlePluginPortal() - } - plugins { - id 'io.quarkus' version "${quarkusPluginVersion}" - } -} ----- - -NOTE:: the `plugins{}` method in `settings.gradle` is not supported in Gradle 5.x. In this case make sure to explicitly declare the plugin version in the `build.gradle` file like the example below: - -[source, groovy, subs=attributes+] ----- -plugins { - id 'java' - id 'io.quarkus' version '{quarkus-version}' -} ----- - - - -// end::repositories[] diff --git a/docs/src/main/asciidoc/gradle-tooling.adoc b/docs/src/main/asciidoc/gradle-tooling.adoc index c769280b74fa5..460efe9b9585a 100644 --- a/docs/src/main/asciidoc/gradle-tooling.adoc +++ b/docs/src/main/asciidoc/gradle-tooling.adoc @@ -4,7 +4,7 @@ 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[] +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: diff --git a/docs/src/main/asciidoc/grpc-getting-started.adoc b/docs/src/main/asciidoc/grpc-getting-started.adoc index c3485e70f6fd8..d34b40f80046f 100644 --- a/docs/src/main/asciidoc/grpc-getting-started.adoc +++ b/docs/src/main/asciidoc/grpc-getting-started.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: serialization :summary: This guide explains how to start using gRPC in your Quarkus application. diff --git a/docs/src/main/asciidoc/grpc-service-consumption.adoc b/docs/src/main/asciidoc/grpc-service-consumption.adoc index 997f6a4ceed42..c75026a7dbecb 100644 --- a/docs/src/main/asciidoc/grpc-service-consumption.adoc +++ b/docs/src/main/asciidoc/grpc-service-consumption.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: serialization :summary: This guide explains how to consume gRPC services in your Quarkus application. diff --git a/docs/src/main/asciidoc/grpc-service-implementation.adoc b/docs/src/main/asciidoc/grpc-service-implementation.adoc index e5281acc61411..1f2561e8f5423 100644 --- a/docs/src/main/asciidoc/grpc-service-implementation.adoc +++ b/docs/src/main/asciidoc/grpc-service-implementation.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: serialization :summary: This guide explains how to implement gRPC services in your Quarkus application. diff --git a/docs/src/main/asciidoc/grpc.adoc b/docs/src/main/asciidoc/grpc.adoc index 173d45ea22d1f..2a1ff09344364 100644 --- a/docs/src/main/asciidoc/grpc.adoc +++ b/docs/src/main/asciidoc/grpc.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = gRPC -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: serialization :summary: Entry point for everything gRPC. diff --git a/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc b/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc index bd979fa302296..d1f109e6f0e62 100644 --- a/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc +++ b/docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/hibernate-orm-panache.adoc b/docs/src/main/asciidoc/hibernate-orm-panache.adoc index bd9a7d4efcfa6..c98ff073ae388 100644 --- a/docs/src/main/asciidoc/hibernate-orm-panache.adoc +++ b/docs/src/main/asciidoc/hibernate-orm-panache.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/hibernate-orm.adoc b/docs/src/main/asciidoc/hibernate-orm.adoc index a2b243b5b043d..bf9d195ac9379 100644 --- a/docs/src/main/asciidoc/hibernate-orm.adoc +++ b/docs/src/main/asciidoc/hibernate-orm.adoc @@ -4,7 +4,7 @@ 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[] +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 @@ -659,7 +659,7 @@ quarkus.hibernate-orm.cache."org.acme.MyEntity".memory.object-count=1000 ==== -include::duration-format-note.adoc[] +include::{includes}/duration-format-note.adoc[] === Limitations of Caching diff --git a/docs/src/main/asciidoc/hibernate-reactive-panache.adoc b/docs/src/main/asciidoc/hibernate-reactive-panache.adoc index 21944fe821395..849ad0b8d768c 100644 --- a/docs/src/main/asciidoc/hibernate-reactive-panache.adoc +++ b/docs/src/main/asciidoc/hibernate-reactive-panache.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: data :summary: Simplified reactive ORM layer based on Hibernate Reactive. :config-file: application.properties diff --git a/docs/src/main/asciidoc/hibernate-reactive.adoc b/docs/src/main/asciidoc/hibernate-reactive.adoc index 71e2ba09573f9..744a298b0014c 100644 --- a/docs/src/main/asciidoc/hibernate-reactive.adoc +++ b/docs/src/main/asciidoc/hibernate-reactive.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Hibernate Reactive -include::./attributes.adoc[] +include::_attributes.adoc[] :config-file: application.properties :reactive-doc-url-prefix: https://hibernate.org/reactive/documentation/1.1/reference/html_single/#getting-started diff --git a/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc b/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc index 60b6309361db4..0b1406948fadb 100644 --- a/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc +++ b/docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc @@ -5,7 +5,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/http-reference.adoc b/docs/src/main/asciidoc/http-reference.adoc index 9fd3e2b2cd442..a5dbe8861abeb 100644 --- a/docs/src/main/asciidoc/http-reference.adoc +++ b/docs/src/main/asciidoc/http-reference.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = HTTP Reference -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: web :summary: Learn more about configuring Quarkus' Vert.x based HTTP layer - and Undertow if you are using servlets. :numbered: diff --git a/docs/src/main/asciidoc/ide-tooling.adoc b/docs/src/main/asciidoc/ide-tooling.adoc index 7be4621e896a7..6ab775495c930 100644 --- a/docs/src/main/asciidoc/ide-tooling.adoc +++ b/docs/src/main/asciidoc/ide-tooling.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: getting-started :summary: Learn more about Quarkus integrations in IDEs. diff --git a/docs/src/main/asciidoc/infinispan-client.adoc b/docs/src/main/asciidoc/infinispan-client.adoc index 00bdf047c11cf..ac4844c252a47 100644 --- a/docs/src/main/asciidoc/infinispan-client.adoc +++ b/docs/src/main/asciidoc/infinispan-client.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Infinispan Client -include::./attributes.adoc[] +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. diff --git a/docs/src/main/asciidoc/jms.adoc b/docs/src/main/asciidoc/jms.adoc index ef4af8535844a..5d7f27d8b99a5 100644 --- a/docs/src/main/asciidoc/jms.adoc +++ b/docs/src/main/asciidoc/jms.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using JMS -include::./attributes.adoc[] +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/jreleaser.adoc b/docs/src/main/asciidoc/jreleaser.adoc index 619a99df6ded5..677dca385ec75 100644 --- a/docs/src/main/asciidoc/jreleaser.adoc +++ b/docs/src/main/asciidoc/jreleaser.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Packaging And Releasing With JReleaser -include::./attributes.adoc[] +include::_attributes.adoc[] :jreleaser-version: 0.9.1 :numbered: diff --git a/docs/src/main/asciidoc/kafka-dev-services.adoc b/docs/src/main/asciidoc/kafka-dev-services.adoc index 299c269167575..30588ba1e1381 100644 --- a/docs/src/main/asciidoc/kafka-dev-services.adoc +++ b/docs/src/main/asciidoc/kafka-dev-services.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: Start Apache Kafka automatically in dev and test modes. diff --git a/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc b/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc index 99c1d5c39c9d1..6e6e2a09e466c 100644 --- a/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc +++ b/docs/src/main/asciidoc/kafka-reactive-getting-started.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: 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 785b6341b6029..55cfc9ac560c9 100644 --- a/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc +++ b/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: Use Apache Kafka, Avro serialized records, and connect to a schema registry. diff --git a/docs/src/main/asciidoc/kafka-streams.adoc b/docs/src/main/asciidoc/kafka-streams.adoc index 47a058fc93c84..ab71139788325 100644 --- a/docs/src/main/asciidoc/kafka-streams.adoc +++ b/docs/src/main/asciidoc/kafka-streams.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/kafka.adoc b/docs/src/main/asciidoc/kafka.adoc index d2eb3fbb52b98..2b8a4a39aa0bb 100644 --- a/docs/src/main/asciidoc/kafka.adoc +++ b/docs/src/main/asciidoc/kafka.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: This reference guide provides an in-depth look on Apache Kafka and Smallrye Reactive Messaging framework. :numbered: @@ -2066,7 +2066,7 @@ The consumer `client.id` is configured according to the number of clients to cre - If a `client.id` is not provided, it is generated as `kafka-consumer-[channel][-index]`. -include::smallrye-kafka-incoming.adoc[] +include::{includes}/smallrye-kafka-incoming.adoc[] === Outgoing channel configuration (writing to Kafka) @@ -2101,7 +2101,7 @@ If not set, `key.serializer` is set to `org.apache.kafka.common.serialization.St If not set, producer `client.id` is generated as `kafka-producer-[channel]`. -include::smallrye-kafka-outgoing.adoc[] +include::{includes}/smallrye-kafka-outgoing.adoc[] [[kafka-configuration-resolution]] === Kafka Configuration Resolution diff --git a/docs/src/main/asciidoc/kogito-dev-services.adoc b/docs/src/main/asciidoc/kogito-dev-services.adoc index 361286d8cce52..5217e77f32419 100644 --- a/docs/src/main/asciidoc/kogito-dev-services.adoc +++ b/docs/src/main/asciidoc/kogito-dev-services.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for Kogito -include::./attributes.adoc[] +include::_attributes.adoc[] If any Kogito process-related extension is present (e.g. `kogito-quarkus` or `kogito-quarkus-processes`), Dev Services for Kogito automatically starts a Data Index in dev mode. So, you don't have to start it manually or have any other service set-up manually. diff --git a/docs/src/main/asciidoc/kogito-dmn.adoc b/docs/src/main/asciidoc/kogito-dmn.adoc index 19cf5cb980293..0cf85879c1085 100644 --- a/docs/src/main/asciidoc/kogito-dmn.adoc +++ b/docs/src/main/asciidoc/kogito-dmn.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: business-automation :summary: 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 c9d62d855ba43..f9b1628f4da18 100644 --- a/docs/src/main/asciidoc/kogito-drl.adoc +++ b/docs/src/main/asciidoc/kogito-drl.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: business-automation :summary: 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 42a97720e615c..e408aec994b87 100644 --- a/docs/src/main/asciidoc/kogito-pmml.adoc +++ b/docs/src/main/asciidoc/kogito-pmml.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: business-automation :summary: 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 2f30b19ca7697..2b5ea56935012 100644 --- a/docs/src/main/asciidoc/kogito.adoc +++ b/docs/src/main/asciidoc/kogito.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/kotlin.adoc b/docs/src/main/asciidoc/kotlin.adoc index 062cdafe80fbd..6a1fa52982194 100644 --- a/docs/src/main/asciidoc/kotlin.adoc +++ b/docs/src/main/asciidoc/kotlin.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Kotlin -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: alt-languages :summary: This guide explains how to use Kotlin. diff --git a/docs/src/main/asciidoc/kubernetes-client.adoc b/docs/src/main/asciidoc/kubernetes-client.adoc index 7b084f0af034b..f803bd55e2248 100644 --- a/docs/src/main/asciidoc/kubernetes-client.adoc +++ b/docs/src/main/asciidoc/kubernetes-client.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Kubernetes Client -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: This guide demonstrates how to use the Fabric8 Kubernetes client to interact with your Kubernetes cluster. diff --git a/docs/src/main/asciidoc/kubernetes-config.adoc b/docs/src/main/asciidoc/kubernetes-config.adoc index 722fc22c58db5..b824b17d4e48b 100644 --- a/docs/src/main/asciidoc/kubernetes-config.adoc +++ b/docs/src/main/asciidoc/kubernetes-config.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Kubernetes Config -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: cloud :summary: Use ConfigMaps as a configuration source for your Quarkus applications. diff --git a/docs/src/main/asciidoc/lifecycle.adoc b/docs/src/main/asciidoc/lifecycle.adoc index a6dedf77f215a..b30f503c0833a 100644 --- a/docs/src/main/asciidoc/lifecycle.adoc +++ b/docs/src/main/asciidoc/lifecycle.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/liquibase-mongodb.adoc b/docs/src/main/asciidoc/liquibase-mongodb.adoc index 6c426827f780f..7dfe6fe30378f 100644 --- a/docs/src/main/asciidoc/liquibase-mongodb.adoc +++ b/docs/src/main/asciidoc/liquibase-mongodb.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Liquibase MongoDB -include::./attributes.adoc[] +include::_attributes.adoc[] :change-log: src/main/resources/db/changeLog.xml :config-file: application.properties diff --git a/docs/src/main/asciidoc/liquibase.adoc b/docs/src/main/asciidoc/liquibase.adoc index e441ae7a4efad..166b6129b13b0 100644 --- a/docs/src/main/asciidoc/liquibase.adoc +++ b/docs/src/main/asciidoc/liquibase.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Liquibase -include::./attributes.adoc[] +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 diff --git a/docs/src/main/asciidoc/logging.adoc b/docs/src/main/asciidoc/logging.adoc index e61f99ecfc2fc..911fc1ad52e47 100644 --- a/docs/src/main/asciidoc/logging.adoc +++ b/docs/src/main/asciidoc/logging.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Configuring Logging -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: core :summary: 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 cc0a2152156a0..fb584080fe4e5 100644 --- a/docs/src/main/asciidoc/lra.adoc +++ b/docs/src/main/asciidoc/lra.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: data :summary: This guides covers the usage of LRA to coordinate activities across services. diff --git a/docs/src/main/asciidoc/mailer-reference.adoc b/docs/src/main/asciidoc/mailer-reference.adoc index 289d4518581f9..5c42fb80e0557 100644 --- a/docs/src/main/asciidoc/mailer-reference.adoc +++ b/docs/src/main/asciidoc/mailer-reference.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Mailer Reference Guide -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: miscellaneous :summary: This reference guide 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 4a0b0874e3785..50247bed360f7 100644 --- a/docs/src/main/asciidoc/mailer.adoc +++ b/docs/src/main/asciidoc/mailer.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: miscellaneous :summary: Learn more about how you can send email from a Quarkus application with our reactive email client. diff --git a/docs/src/main/asciidoc/maven-tooling.adoc b/docs/src/main/asciidoc/maven-tooling.adoc index ff5a4b4749baf..96f6becb61547 100644 --- a/docs/src/main/asciidoc/maven-tooling.adoc +++ b/docs/src/main/asciidoc/maven-tooling.adoc @@ -4,7 +4,7 @@ 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[] +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: diff --git a/docs/src/main/asciidoc/micrometer.adoc b/docs/src/main/asciidoc/micrometer.adoc index 228570c06fea7..b8fefe6a3e7d5 100644 --- a/docs/src/main/asciidoc/micrometer.adoc +++ b/docs/src/main/asciidoc/micrometer.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Micrometer Metrics -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: observability :summary: This guide demonstrates how your Quarkus application can collect metrics using the Micrometer extension. diff --git a/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc b/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc index 5dc441f16314c..7a28074d3724e 100644 --- a/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc +++ b/docs/src/main/asciidoc/mongodb-panache-kotlin.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/mongodb-panache.adoc b/docs/src/main/asciidoc/mongodb-panache.adoc index bad93fc0fddb4..6e27b79152d45 100644 --- a/docs/src/main/asciidoc/mongodb-panache.adoc +++ b/docs/src/main/asciidoc/mongodb-panache.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: data :summary: This guide covers the usage of MongoDB using active records and repositories. :config-file: application.properties diff --git a/docs/src/main/asciidoc/mongodb.adoc b/docs/src/main/asciidoc/mongodb.adoc index a7c1762d0763c..d7d278dca2807 100644 --- a/docs/src/main/asciidoc/mongodb.adoc +++ b/docs/src/main/asciidoc/mongodb.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the MongoDB Client -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: data :summary: This guide covers how to use MongoDB in Quarkus. diff --git a/docs/src/main/asciidoc/mutiny-primer.adoc b/docs/src/main/asciidoc/mutiny-primer.adoc index 4b7ecb8aa5a62..a6517d9e22275 100644 --- a/docs/src/main/asciidoc/mutiny-primer.adoc +++ b/docs/src/main/asciidoc/mutiny-primer.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Mutiny - Async for bare mortal -include::./attributes.adoc[] +include::_attributes.adoc[] https://smallrye.io/smallrye-mutiny[Mutiny] is an intuitive, reactive programming library. It is the primary model to write reactive applications with Quarkus. diff --git a/docs/src/main/asciidoc/native-and-ssl.adoc b/docs/src/main/asciidoc/native-and-ssl.adoc index a63195ed23e8c..7b126d560f2f0 100644 --- a/docs/src/main/asciidoc/native-and-ssl.adoc +++ b/docs/src/main/asciidoc/native-and-ssl.adoc @@ -4,7 +4,7 @@ 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[] +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: diff --git a/docs/src/main/asciidoc/native-reference.adoc b/docs/src/main/asciidoc/native-reference.adoc index 72420aeb59a47..12c11f5c1dec4 100644 --- a/docs/src/main/asciidoc/native-reference.adoc +++ b/docs/src/main/asciidoc/native-reference.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Native Reference Guide -include::./attributes.adoc[] +include::_attributes.adoc[] This guide is a companion to the xref:building-native-image.adoc[Building a Native Executable], diff --git a/docs/src/main/asciidoc/openapi-swaggerui.adoc b/docs/src/main/asciidoc/openapi-swaggerui.adoc index bbd973e14a1d7..f2558a4d3fdb3 100644 --- a/docs/src/main/asciidoc/openapi-swaggerui.adoc +++ b/docs/src/main/asciidoc/openapi-swaggerui.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/opentelemetry.adoc b/docs/src/main/asciidoc/opentelemetry.adoc index 58ca4f5192512..e66ab4dfee667 100644 --- a/docs/src/main/asciidoc/opentelemetry.adoc +++ b/docs/src/main/asciidoc/opentelemetry.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenTelemetry -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: observability :summary: This guide explains how your Quarkus application can utilize 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 8951c29c40493..17a488c4d15b3 100644 --- a/docs/src/main/asciidoc/opentracing.adoc +++ b/docs/src/main/asciidoc/opentracing.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenTracing :extension-status: deprecated -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: observability :summary: 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 d00bc3754be95..abac11775db43 100644 --- a/docs/src/main/asciidoc/optaplanner.adoc +++ b/docs/src/main/asciidoc/optaplanner.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/performance-measure.adoc b/docs/src/main/asciidoc/performance-measure.adoc index c4135610ecb8d..cd261ce68ef95 100644 --- a/docs/src/main/asciidoc/performance-measure.adoc +++ b/docs/src/main/asciidoc/performance-measure.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Measuring Performance -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: miscellaneous :summary: This guide explains how to best measure the footprint of a Quarkus application. diff --git a/docs/src/main/asciidoc/picocli.adoc b/docs/src/main/asciidoc/picocli.adoc index 704e1b11b0f63..bd4c109888fd4 100644 --- a/docs/src/main/asciidoc/picocli.adoc +++ b/docs/src/main/asciidoc/picocli.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: command-line :summary: Simplify command line applications creation with the Picocli extension. diff --git a/docs/src/main/asciidoc/platform.adoc b/docs/src/main/asciidoc/platform.adoc index 50d785d02a01e..65df86088d0a2 100644 --- a/docs/src/main/asciidoc/platform.adoc +++ b/docs/src/main/asciidoc/platform.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Platform -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: architecture :summary: Learn more about what we call a Platform in the Quarkus world. diff --git a/docs/src/main/asciidoc/podman.adoc b/docs/src/main/asciidoc/podman.adoc index eb0dd433fff02..0c265075dede5 100644 --- a/docs/src/main/asciidoc/podman.adoc +++ b/docs/src/main/asciidoc/podman.adoc @@ -4,6 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Podman with Quarkus +include::_attributes.adoc[] https://podman.io/[Podman] is a daemonless and rootless container engine for developing, managing, and running OCI Containers on your Linux system or other OS. If you're using Podman with Quarkus, some one-off setup is needed, but once it's done, you can take advantage of all the Quarkus features. diff --git a/docs/src/main/asciidoc/quarkus-intro.adoc b/docs/src/main/asciidoc/quarkus-intro.adoc deleted file mode 100644 index 01505454c23b9..0000000000000 --- a/docs/src/main/asciidoc/quarkus-intro.adoc +++ /dev/null @@ -1,79 +0,0 @@ -= What is Quarkus - -include::./attributes.adoc[] -:toc: macro -:toclevels: 4 -:doctype: book -:icons: font -:docinfo1: - -:numbered: -:sectnums: -:sectnumlevels: 4 - -// tag::intro[] - -[quote] --- -Quarkus is a Cloud Native, Container First framework for writing Java applications. --- - -Container First:: -Minimal footprint Java applications optimized for running in containers -Cloud Native:: -Embraces 12 factor architecture in environments like Kubernetes -Unify imperative and reactive:: -Brings under one programming model non-blocking and imperative styles of development -Standards-based:: -Based on the standards and the libraries you love and use (RESTEasy Reactive, Hibernate, Netty, Eclipse Vert.x, Apache Camel...) -Microservice First:: -Brings lightning fast startup time to Java applications -Extreme productivity:: -Instant hot code replacement: don't allow build, deploy, boot delays disrupt your flow -Developer Joy:: -Development-centric experience without compromises to bring your amazing applications to life in no time - -All under one framework. - -// end::intro[] - -== Scratch pad - - -Quarkus believes in developer Joy. - - -It unifies imperative and reactive. -It is a Microservice first toolkit. - -Standards based -Quarkus brings all the standards and frameworks you love and use: RESTEasy Reactive, Hibernate, Netty, vert.x, Camel...) - -Imperative and Reactive - -* ahead-of-time native binary (executable binary) -* Cloud Native -* Java -* modular -* Substrate VM native - -Seamlessly build container optimal - -Container affinity - -Container optimal - -* low memory -* low startup time -* ahead of time optimal - -Unifying Imperative and Reactive under one framework. - -Usability -* easy to use -* productive environment -* hot reload - -Standards based - - diff --git a/docs/src/main/asciidoc/quarkus-maven-plugin.adoc b/docs/src/main/asciidoc/quarkus-maven-plugin.adoc index 249c48287672c..aadebc85ea9e6 100644 --- a/docs/src/main/asciidoc/quarkus-maven-plugin.adoc +++ b/docs/src/main/asciidoc/quarkus-maven-plugin.adoc @@ -8,7 +8,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc The Quarkus Maven Plugin builds the Quarkus applications, and provides helpers to launch dev mode or build native executables. For more information about how to use the Quarkus Maven Plugin, please refer to the xref:maven-tooling.adoc[Maven Tooling guide]. -include::./attributes.adoc[] +include::_attributes.adoc[] == Discover Maven goals diff --git a/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc b/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc index d12696d6616dc..27e2b760e25fd 100644 --- a/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc +++ b/docs/src/main/asciidoc/quarkus-reactive-architecture.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Reactive Architecture -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: architecture :summary: Learn more about Quarkus reactive architecture. diff --git a/docs/src/main/asciidoc/quarkus-runtime-base-image.adoc b/docs/src/main/asciidoc/quarkus-runtime-base-image.adoc index 7516166b8d77e..fb6872af60199 100644 --- a/docs/src/main/asciidoc/quarkus-runtime-base-image.adoc +++ b/docs/src/main/asciidoc/quarkus-runtime-base-image.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Base Runtime Image -include::./attributes.adoc[] +include::_attributes.adoc[] To ease the containerization of native executables, Quarkus provides a base image providing the requirements to run these executables. The `quarkus-micro-image:1.0` image is: diff --git a/docs/src/main/asciidoc/quartz.adoc b/docs/src/main/asciidoc/quartz.adoc index dd896b741dbd7..0cb5dc145c3b0 100644 --- a/docs/src/main/asciidoc/quartz.adoc +++ b/docs/src/main/asciidoc/quartz.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/qute-reference.adoc b/docs/src/main/asciidoc/qute-reference.adoc index c0ef6944dba66..e43049f536e08 100644 --- a/docs/src/main/asciidoc/qute-reference.adoc +++ b/docs/src/main/asciidoc/qute-reference.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Qute Reference Guide -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: miscellaneous :summary: Learn everything you need to know about the Qute template engine. :numbered: diff --git a/docs/src/main/asciidoc/qute.adoc b/docs/src/main/asciidoc/qute.adoc index bf511bb9f46e3..a4d8be410882e 100644 --- a/docs/src/main/asciidoc/qute.adoc +++ b/docs/src/main/asciidoc/qute.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Qute Templating Engine -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: miscellaneous :summary: Learn more about how you can use templating in your applications with the Qute template engine. diff --git a/docs/src/main/asciidoc/rabbitmq-dev-services.adoc b/docs/src/main/asciidoc/rabbitmq-dev-services.adoc index 953f8bc5980b8..bbcdef597b99a 100644 --- a/docs/src/main/asciidoc/rabbitmq-dev-services.adoc +++ b/docs/src/main/asciidoc/rabbitmq-dev-services.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for RabbitMQ -include::./attributes.adoc[] +include::_attributes.adoc[] Dev Services for RabbitMQ automatically starts a RabbitMQ 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/rabbitmq-reference.adoc b/docs/src/main/asciidoc/rabbitmq-reference.adoc index 2b512b7064004..52a7fdb5e32d4 100644 --- a/docs/src/main/asciidoc/rabbitmq-reference.adoc +++ b/docs/src/main/asciidoc/rabbitmq-reference.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Reactive Messaging RabbitMQ Connector Reference Documentation -include::./attributes.adoc[] +include::_attributes.adoc[] This guide is the companion from the xref:rabbitmq.adoc[Getting Started with RabbitMQ]. It explains in more details the configuration and usage of the RabbitMQ connector for reactive messaging. diff --git a/docs/src/main/asciidoc/rabbitmq.adoc b/docs/src/main/asciidoc/rabbitmq.adoc index 477b874aa6f6c..9307e0c72ad52 100644 --- a/docs/src/main/asciidoc/rabbitmq.adoc +++ b/docs/src/main/asciidoc/rabbitmq.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Getting Started to SmallRye Reactive Messaging with RabbitMQ :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with RabbitMQ. diff --git a/docs/src/main/asciidoc/reactive-event-bus.adoc b/docs/src/main/asciidoc/reactive-event-bus.adoc index 91862024ea465..7c2da2420748a 100644 --- a/docs/src/main/asciidoc/reactive-event-bus.adoc +++ b/docs/src/main/asciidoc/reactive-event-bus.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: messaging :summary: This guide explains how different beans can interact using the event bus. diff --git a/docs/src/main/asciidoc/reactive-routes.adoc b/docs/src/main/asciidoc/reactive-routes.adoc index 6d719e6b97e26..04a39e0a3856a 100644 --- a/docs/src/main/asciidoc/reactive-routes.adoc +++ b/docs/src/main/asciidoc/reactive-routes.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Reactive Routes -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: web :summary: This guide demonstrates how to use reactive routes. diff --git a/docs/src/main/asciidoc/reactive-sql-clients.adoc b/docs/src/main/asciidoc/reactive-sql-clients.adoc index 3c5ab8e9d6bc0..92583127f3f65 100644 --- a/docs/src/main/asciidoc/reactive-sql-clients.adoc +++ b/docs/src/main/asciidoc/reactive-sql-clients.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Reactive SQL Clients -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: data :summary: This guide covers how to use the Reactive SQL Clients in Quarkus. :config-file: application.properties diff --git a/docs/src/main/asciidoc/reaugmentation.adoc b/docs/src/main/asciidoc/reaugmentation.adoc index 0c66c9fcd0f13..d95d0bee6b687 100644 --- a/docs/src/main/asciidoc/reaugmentation.adoc +++ b/docs/src/main/asciidoc/reaugmentation.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: tooling :summary: Use mutable jars to rebuild your application with different build time configurations. diff --git a/docs/src/main/asciidoc/redis-dev-services.adoc b/docs/src/main/asciidoc/redis-dev-services.adoc index f9ecf47b5993d..802dca7253276 100644 --- a/docs/src/main/asciidoc/redis-dev-services.adoc +++ b/docs/src/main/asciidoc/redis-dev-services.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Dev Services for Redis :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: data :summary: Start Redis automatically in dev and test modes. diff --git a/docs/src/main/asciidoc/redis-reference.adoc b/docs/src/main/asciidoc/redis-reference.adoc index c3c5938d34463..111c80a336edd 100644 --- a/docs/src/main/asciidoc/redis-reference.adoc +++ b/docs/src/main/asciidoc/redis-reference.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Redis Extension Reference Guide :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :numbered: :sectnums: diff --git a/docs/src/main/asciidoc/redis.adoc b/docs/src/main/asciidoc/redis.adoc index 9644a79b0063c..1916e4cc31d83 100644 --- a/docs/src/main/asciidoc/redis.adoc +++ b/docs/src/main/asciidoc/redis.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using the Redis Client :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: data :summary: This guide covers how to use a Redis datastore in Quarkus. diff --git a/docs/src/main/asciidoc/rest-client-multipart.adoc b/docs/src/main/asciidoc/rest-client-multipart.adoc index fbfa3587c1ab8..bd13bb7bc0698 100644 --- a/docs/src/main/asciidoc/rest-client-multipart.adoc +++ b/docs/src/main/asciidoc/rest-client-multipart.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/rest-client-reactive.adoc b/docs/src/main/asciidoc/rest-client-reactive.adoc index 8e84aee3392a4..ecd65dcc1ca52 100644 --- a/docs/src/main/asciidoc/rest-client-reactive.adoc +++ b/docs/src/main/asciidoc/rest-client-reactive.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: web :summary: This guide explains how to use the RESTEasy Reactive REST Client. diff --git a/docs/src/main/asciidoc/rest-client.adoc b/docs/src/main/asciidoc/rest-client.adoc index 04d46b711192a..4e51d0674663a 100644 --- a/docs/src/main/asciidoc/rest-client.adoc +++ b/docs/src/main/asciidoc/rest-client.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/rest-data-panache.adoc b/docs/src/main/asciidoc/rest-data-panache.adoc index ddc199665399a..2f10580f48693 100644 --- a/docs/src/main/asciidoc/rest-data-panache.adoc +++ b/docs/src/main/asciidoc/rest-data-panache.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/rest-json.adoc b/docs/src/main/asciidoc/rest-json.adoc index 537e24da2dc33..1fce2982196c6 100644 --- a/docs/src/main/asciidoc/rest-json.adoc +++ b/docs/src/main/asciidoc/rest-json.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/resteasy-reactive-migration.adoc b/docs/src/main/asciidoc/resteasy-reactive-migration.adoc index 74e7778bd7935..f4e6674e015a9 100644 --- a/docs/src/main/asciidoc/resteasy-reactive-migration.adoc +++ b/docs/src/main/asciidoc/resteasy-reactive-migration.adoc @@ -4,6 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Migrating to RESTEasy Reactive +include::_attributes.adoc[] Migrating from RESTEasy Classic to RESTEasy Reactive is straightforward in most cases, however there are a few cases that require some attention. This document provides a list of issues users attempting the migration should be aware of. diff --git a/docs/src/main/asciidoc/resteasy-reactive.adoc b/docs/src/main/asciidoc/resteasy-reactive.adoc index 39f6b55a5c524..2280368ece3a6 100644 --- a/docs/src/main/asciidoc/resteasy-reactive.adoc +++ b/docs/src/main/asciidoc/resteasy-reactive.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/resteasy.adoc b/docs/src/main/asciidoc/resteasy.adoc index 361293e81b8f6..9e6a936527aa0 100644 --- a/docs/src/main/asciidoc/resteasy.adoc +++ b/docs/src/main/asciidoc/resteasy.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = RESTEasy Classic -include::./attributes.adoc[] +include::_attributes.adoc[] [WARNING] ==== diff --git a/docs/src/main/asciidoc/scheduler-reference.adoc b/docs/src/main/asciidoc/scheduler-reference.adoc index 05dfd67251d15..79ea30780ee81 100644 --- a/docs/src/main/asciidoc/scheduler-reference.adoc +++ b/docs/src/main/asciidoc/scheduler-reference.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Scheduler Reference Guide -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: miscellaneous :summary: Learn more about the Scheduler extension. :numbered: diff --git a/docs/src/main/asciidoc/scheduler.adoc b/docs/src/main/asciidoc/scheduler.adoc index e165cf67d9f4b..bf9cb8b4526eb 100644 --- a/docs/src/main/asciidoc/scheduler.adoc +++ b/docs/src/main/asciidoc/scheduler.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Scheduling Periodic Tasks -include::./attributes.adoc[] +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. diff --git a/docs/src/main/asciidoc/scripting.adoc b/docs/src/main/asciidoc/scripting.adoc index 7afcb970ed363..923157b4cb038 100644 --- a/docs/src/main/asciidoc/scripting.adoc +++ b/docs/src/main/asciidoc/scripting.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Scripting with Quarkus -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: command-line :summary: Easy Quarkus-based scripting with jbang. :extension-status: preview diff --git a/docs/src/main/asciidoc/security-authorization.adoc b/docs/src/main/asciidoc/security-authorization.adoc index 9a8c980cdda7d..0d91d3b6902ab 100644 --- a/docs/src/main/asciidoc/security-authorization.adoc +++ b/docs/src/main/asciidoc/security-authorization.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Authorization of Web Endpoints -include::./attributes.adoc[] +include::_attributes.adoc[] Quarkus has an integrated pluggable web security layer. If security is enabled all HTTP requests will have a permission check performed to make sure they are allowed to continue. diff --git a/docs/src/main/asciidoc/security-basic-auth-concept.adoc b/docs/src/main/asciidoc/security-basic-auth-concept.adoc index a7ce5c9c2993d..940a415b62d0e 100644 --- a/docs/src/main/asciidoc/security-basic-auth-concept.adoc +++ b/docs/src/main/asciidoc/security-basic-auth-concept.adoc @@ -1,5 +1,6 @@ [id="security-basic-auth-concept"] = Basic Authentication +include::_attributes.adoc[] HTTP Basic Authentication is one of the least resource-demanding techniques that enforce access controls to the Web resources. It uses fields in the HTTP header and does not require HTTP cookies, session identifiers, or login pages. diff --git a/docs/src/main/asciidoc/security-built-in-authentication.adoc b/docs/src/main/asciidoc/security-built-in-authentication.adoc index ef311c393d366..ab606a8e0334f 100644 --- a/docs/src/main/asciidoc/security-built-in-authentication.adoc +++ b/docs/src/main/asciidoc/security-built-in-authentication.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Built-In Authentication Support -include::./attributes.adoc[] +include::_attributes.adoc[] The following section describes the Quarkus built-in authentication mechanisms for HTTP based FORM, BASIC, and Mutual TLS authentication. Proactive authentication is also described. diff --git a/docs/src/main/asciidoc/security-csrf-prevention.adoc b/docs/src/main/asciidoc/security-csrf-prevention.adoc index a1e4d5c21d3ac..bd08be5ce3d7c 100644 --- a/docs/src/main/asciidoc/security-csrf-prevention.adoc +++ b/docs/src/main/asciidoc/security-csrf-prevention.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Cross-Site Request Forgery Prevention -include::./attributes.adoc[] +include::_attributes.adoc[] https://owasp.org/www-community/attacks/csrf[Cross-Site Request Forgery (CSRF)] is an attack that forces an end user to execute unwanted actions on a web application in which they are currently authenticated. diff --git a/docs/src/main/asciidoc/security-customization.adoc b/docs/src/main/asciidoc/security-customization.adoc index 456090e604ee2..ef21c09d80b6f 100644 --- a/docs/src/main/asciidoc/security-customization.adoc +++ b/docs/src/main/asciidoc/security-customization.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Security Tips and Tricks -include::./attributes.adoc[] +include::_attributes.adoc[] == Quarkus Security Dependency diff --git a/docs/src/main/asciidoc/security-enabling-basic-auth-howto.adoc b/docs/src/main/asciidoc/security-enabling-basic-auth-howto.adoc index 5d0e200cd0b29..10dbc74fb50b4 100644 --- a/docs/src/main/asciidoc/security-enabling-basic-auth-howto.adoc +++ b/docs/src/main/asciidoc/security-enabling-basic-auth-howto.adoc @@ -1,5 +1,6 @@ [id="security-enabling-basic-auth-howto"] = Enable HTTP Basic authentication +include::_attributes.adoc[] Enable the HTTP Basic authentication for your Quarkus project and allow users to authenticate with a username and password. diff --git a/docs/src/main/asciidoc/security-enabling-basic-auth-tutorial.adoc b/docs/src/main/asciidoc/security-enabling-basic-auth-tutorial.adoc index 8429f0a645400..93f86bc2fe192 100644 --- a/docs/src/main/asciidoc/security-enabling-basic-auth-tutorial.adoc +++ b/docs/src/main/asciidoc/security-enabling-basic-auth-tutorial.adoc @@ -1,5 +1,6 @@ [id="security-enabling-basic-auth-tutorial"] = Enable Basic Authentication +include::_attributes.adoc[] Enable the Basic Authentication for your Quarkus project and allow users to authenticate with a username and password. diff --git a/docs/src/main/asciidoc/security-getting-started.adoc b/docs/src/main/asciidoc/security-getting-started.adoc index 14488c1bd9d0e..cd80c68c78a65 100644 --- a/docs/src/main/asciidoc/security-getting-started.adoc +++ b/docs/src/main/asciidoc/security-getting-started.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Secure a Quarkus application with Basic authentication -include::./attributes.adoc[] +include::_attributes.adoc[] Secure your Quarkus application endpoints by combining xref:security-built-in-authentication.adoc#basic-auth[Quarkus built-in basic HTTP authentication] with the JPA identity provider to enable role-based access control (RBAC). The JPA `IdentityProvider` creates a `SecurityIdentity` instance, which is used during user authentication to verify and authorize access requests making your Quarkus application secure. diff --git a/docs/src/main/asciidoc/security-jdbc.adoc b/docs/src/main/asciidoc/security-jdbc.adoc index 2864cb0b22e7f..25091a1a6ab7e 100644 --- a/docs/src/main/asciidoc/security-jdbc.adoc +++ b/docs/src/main/asciidoc/security-jdbc.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: security :summary: 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-build.adoc b/docs/src/main/asciidoc/security-jwt-build.adoc index ca9519d58fc58..dd4133e357026 100644 --- a/docs/src/main/asciidoc/security-jwt-build.adoc +++ b/docs/src/main/asciidoc/security-jwt-build.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Build, Sign and Encrypt JSON Web Tokens -include::./attributes.adoc[] +include::_attributes.adoc[] :toc: According to link:https://datatracker.ietf.org/doc/html/rfc7519[RFC7519], JSON Web Token (JWT) is a compact, URL-safe means of representing claims which are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code(MAC) and/or encrypted. diff --git a/docs/src/main/asciidoc/security-jwt.adoc b/docs/src/main/asciidoc/security-jwt.adoc index b58e40642b2cc..a1b3d88efadeb 100644 --- a/docs/src/main/asciidoc/security-jwt.adoc +++ b/docs/src/main/asciidoc/security-jwt.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using JWT RBAC -include::./attributes.adoc[] +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 diff --git a/docs/src/main/asciidoc/security-keycloak-admin-client.adoc b/docs/src/main/asciidoc/security-keycloak-admin-client.adoc index 09e5b20afb637..9557e239f8c7f 100644 --- a/docs/src/main/asciidoc/security-keycloak-admin-client.adoc +++ b/docs/src/main/asciidoc/security-keycloak-admin-client.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Keycloak Admin Client -include::./attributes.adoc[] +include::_attributes.adoc[] The Quarkus Keycloak Admin Client and its reactive twin support Keycloak Admin Client which can be used to configure a running Keycloak server. diff --git a/docs/src/main/asciidoc/security-keycloak-authorization.adoc b/docs/src/main/asciidoc/security-keycloak-authorization.adoc index c3da97480c563..09d9aae5261a0 100644 --- a/docs/src/main/asciidoc/security-keycloak-authorization.adoc +++ b/docs/src/main/asciidoc/security-keycloak-authorization.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: security :summary: This guide demonstrates how your Quarkus application can authorize access to protected resources using Keycloak Authorization Services. diff --git a/docs/src/main/asciidoc/security-ldap.adoc b/docs/src/main/asciidoc/security-ldap.adoc index 70956f9f00f16..396c9ed44eba1 100644 --- a/docs/src/main/asciidoc/security-ldap.adoc +++ b/docs/src/main/asciidoc/security-ldap.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: security :summary: This guide demonstrates how your Quarkus application can use a LDAP directory to store your user identities. diff --git a/docs/src/main/asciidoc/security-oauth2.adoc b/docs/src/main/asciidoc/security-oauth2.adoc index 680f37c3fd26a..66fc2264ac2ce 100644 --- a/docs/src/main/asciidoc/security-oauth2.adoc +++ b/docs/src/main/asciidoc/security-oauth2.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OAuth2 RBAC -include::./attributes.adoc[] +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 diff --git a/docs/src/main/asciidoc/security-openid-connect-client-reference.adoc b/docs/src/main/asciidoc/security-openid-connect-client-reference.adoc index a0b831a5fc234..c8b4e5d3ab4d0 100644 --- a/docs/src/main/asciidoc/security-openid-connect-client-reference.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-client-reference.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = OpenID Connect (OIDC) and OAuth2 Client and Filters Reference Guide -include::./attributes.adoc[] +include::_attributes.adoc[] :toc: This reference guide explains how to use: diff --git a/docs/src/main/asciidoc/security-openid-connect-client.adoc b/docs/src/main/asciidoc/security-openid-connect-client.adoc index 4045042a74344..18b369379282e 100644 --- a/docs/src/main/asciidoc/security-openid-connect-client.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-client.adoc @@ -4,7 +4,7 @@ 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[] +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: 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 eba4429548344..324f1c126e3e6 100644 --- a/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-dev-services.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: security :summary: Start Keycloak or other providers automatically in dev and test modes. diff --git a/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc b/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc index 9261e8a65a316..1b99ad1d22eec 100644 --- a/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc @@ -4,7 +4,7 @@ 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[] +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: diff --git a/docs/src/main/asciidoc/security-openid-connect-providers.adoc b/docs/src/main/asciidoc/security-openid-connect-providers.adoc index 047069e08920a..b6bf7fd57c3df 100644 --- a/docs/src/main/asciidoc/security-openid-connect-providers.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-providers.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Configuring Well-Known OpenID Connect Providers -include::./attributes.adoc[] +include::_attributes.adoc[] == Introduction 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 b652232978e98..cc1436778512f 100644 --- a/docs/src/main/asciidoc/security-openid-connect-web-authentication.adoc +++ b/docs/src/main/asciidoc/security-openid-connect-web-authentication.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = OpenID Connect (OIDC) authorization code flow mechanism -include::./attributes.adoc[] +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: diff --git a/docs/src/main/asciidoc/security-openid-connect.adoc b/docs/src/main/asciidoc/security-openid-connect.adoc index 20005509bd983..f9010e99c9852 100644 --- a/docs/src/main/asciidoc/security-openid-connect.adoc +++ b/docs/src/main/asciidoc/security-openid-connect.adoc @@ -4,7 +4,7 @@ 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[] +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: diff --git a/docs/src/main/asciidoc/security-properties.adoc b/docs/src/main/asciidoc/security-properties.adoc index c7cea6349cfb3..cf210935297be 100644 --- a/docs/src/main/asciidoc/security-properties.adoc +++ b/docs/src/main/asciidoc/security-properties.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: security :summary: This guide demonstrates how your Quarkus application can use a .properties file to store your user identities. diff --git a/docs/src/main/asciidoc/security-testing.adoc b/docs/src/main/asciidoc/security-testing.adoc index 35d59a157206c..18c9d44a5daef 100644 --- a/docs/src/main/asciidoc/security-testing.adoc +++ b/docs/src/main/asciidoc/security-testing.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Security Testing -include::./attributes.adoc[] +include::_attributes.adoc[] This document describes how to test Quarkus Security. diff --git a/docs/src/main/asciidoc/security-webauthn.adoc b/docs/src/main/asciidoc/security-webauthn.adoc index 5459432e98daf..b73edbc98da56 100644 --- a/docs/src/main/asciidoc/security-webauthn.adoc +++ b/docs/src/main/asciidoc/security-webauthn.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Using Security with WebAuthn :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] This guide demonstrates how your Quarkus application can use WebAuthn authentication instead of passwords. diff --git a/docs/src/main/asciidoc/security.adoc b/docs/src/main/asciidoc/security.adoc index 60c7fc8cfd267..76f91057c4b9f 100644 --- a/docs/src/main/asciidoc/security.adoc +++ b/docs/src/main/asciidoc/security.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Quarkus Security overview -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: security :summary: This guide is the entry point for everything security in Quarkus. diff --git a/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc b/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc index fea6531bd047a..89ac22f169bd5 100644 --- a/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc +++ b/docs/src/main/asciidoc/smallrye-fault-tolerance.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye Fault Tolerance -include::./attributes.adoc[] +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. diff --git a/docs/src/main/asciidoc/smallrye-graphql-client.adoc b/docs/src/main/asciidoc/smallrye-graphql-client.adoc index 7ac4cada0a413..6bafc2ea51b8f 100644 --- a/docs/src/main/asciidoc/smallrye-graphql-client.adoc +++ b/docs/src/main/asciidoc/smallrye-graphql-client.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye GraphQL Client -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: web :summary: This guide explains how to leverage SmallRye GraphQL Client to consume GraphQL services. diff --git a/docs/src/main/asciidoc/smallrye-graphql.adoc b/docs/src/main/asciidoc/smallrye-graphql.adoc index 5aa3edc3121f6..729362c1e7d92 100644 --- a/docs/src/main/asciidoc/smallrye-graphql.adoc +++ b/docs/src/main/asciidoc/smallrye-graphql.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye GraphQL -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: web :summary: This guide explains how to leverage SmallRye GraphQL to implement GraphQL services. diff --git a/docs/src/main/asciidoc/smallrye-health.adoc b/docs/src/main/asciidoc/smallrye-health.adoc index ed5b983288f53..3c85c82dd6067 100644 --- a/docs/src/main/asciidoc/smallrye-health.adoc +++ b/docs/src/main/asciidoc/smallrye-health.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = SmallRye Health -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: observability :summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Health extension. diff --git a/docs/src/main/asciidoc/smallrye-metrics.adoc b/docs/src/main/asciidoc/smallrye-metrics.adoc index 57a530ab93383..442c69bf7b9c5 100644 --- a/docs/src/main/asciidoc/smallrye-metrics.adoc +++ b/docs/src/main/asciidoc/smallrye-metrics.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = SmallRye Metrics :extension-status: deprecated -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: observability :summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Metrics extension. diff --git a/docs/src/main/asciidoc/software-transactional-memory.adoc b/docs/src/main/asciidoc/software-transactional-memory.adoc index 7ae692e5f606c..76da5aee902db 100644 --- a/docs/src/main/asciidoc/software-transactional-memory.adoc +++ b/docs/src/main/asciidoc/software-transactional-memory.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: data :summary: This guides covers the usage of Software Transactional Memory (STM). :extension-status: preview diff --git a/docs/src/main/asciidoc/spring-boot-properties.adoc b/docs/src/main/asciidoc/spring-boot-properties.adoc index 85db68c6c2075..a16883b97dde1 100644 --- a/docs/src/main/asciidoc/spring-boot-properties.adoc +++ b/docs/src/main/asciidoc/spring-boot-properties.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: compatibility :summary: Use Spring Boot's `@ConfigurationProperties` in place of MicroProfile Config annotations diff --git a/docs/src/main/asciidoc/spring-cache.adoc b/docs/src/main/asciidoc/spring-cache.adoc index 712a10e5fc335..05e7de56ae5c9 100644 --- a/docs/src/main/asciidoc/spring-cache.adoc +++ b/docs/src/main/asciidoc/spring-cache.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/spring-cloud-config-client.adoc b/docs/src/main/asciidoc/spring-cloud-config-client.adoc index 7e5f9c232cab1..12978d647ccec 100644 --- a/docs/src/main/asciidoc/spring-cloud-config-client.adoc +++ b/docs/src/main/asciidoc/spring-cloud-config-client.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/spring-data-jpa.adoc b/docs/src/main/asciidoc/spring-data-jpa.adoc index 81c41ecc12b5a..66350c5c6578a 100644 --- a/docs/src/main/asciidoc/spring-data-jpa.adoc +++ b/docs/src/main/asciidoc/spring-data-jpa.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/spring-data-rest.adoc b/docs/src/main/asciidoc/spring-data-rest.adoc index de693259eccd9..efabca09ab41c 100644 --- a/docs/src/main/asciidoc/spring-data-rest.adoc +++ b/docs/src/main/asciidoc/spring-data-rest.adoc @@ -4,7 +4,7 @@ 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[] +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 diff --git a/docs/src/main/asciidoc/spring-di.adoc b/docs/src/main/asciidoc/spring-di.adoc index ff217395422a8..1b2100e4aaab0 100644 --- a/docs/src/main/asciidoc/spring-di.adoc +++ b/docs/src/main/asciidoc/spring-di.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/spring-scheduled.adoc b/docs/src/main/asciidoc/spring-scheduled.adoc index a1ebb1b7813b9..e96aaf3123c4c 100644 --- a/docs/src/main/asciidoc/spring-scheduled.adoc +++ b/docs/src/main/asciidoc/spring-scheduled.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/spring-security.adoc b/docs/src/main/asciidoc/spring-security.adoc index 3ca8b59de9718..4ecbc34b71066 100644 --- a/docs/src/main/asciidoc/spring-security.adoc +++ b/docs/src/main/asciidoc/spring-security.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/spring-web.adoc b/docs/src/main/asciidoc/spring-web.adoc index d0279f7b9accb..ce6664f34b23a 100644 --- a/docs/src/main/asciidoc/spring-web.adoc +++ b/docs/src/main/asciidoc/spring-web.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/stork-kubernetes.adoc b/docs/src/main/asciidoc/stork-kubernetes.adoc index 3308b363b6621..41a12b19cfdef 100644 --- a/docs/src/main/asciidoc/stork-kubernetes.adoc +++ b/docs/src/main/asciidoc/stork-kubernetes.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Using Stork with Kubernetes :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] This guide explains how to use Stork with Kubernetes for service discovery and load balancing. diff --git a/docs/src/main/asciidoc/stork-reference.adoc b/docs/src/main/asciidoc/stork-reference.adoc index 07f8f45f461a5..77a143ffd7288 100644 --- a/docs/src/main/asciidoc/stork-reference.adoc +++ b/docs/src/main/asciidoc/stork-reference.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Stork Reference Guide :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] This guide is the companion from the xref:stork.adoc[Stork Getting Started Guide]. It explains the configuration and usage of SmallRye Stork integration in Quarkus. diff --git a/docs/src/main/asciidoc/stork.adoc b/docs/src/main/asciidoc/stork.adoc index 9c5203af9fb1f..63cfbe7bf924e 100644 --- a/docs/src/main/asciidoc/stork.adoc +++ b/docs/src/main/asciidoc/stork.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Getting Started with SmallRye Stork :extension-status: preview -include::./attributes.adoc[] +include::_attributes.adoc[] The essence of distributed systems resides in the interaction between services. In modern architecture, you often have multiple instances of your service to share the load or improve the resilience by redundancy. diff --git a/docs/src/main/asciidoc/telemetry-micrometer-tutorial.adoc b/docs/src/main/asciidoc/telemetry-micrometer-tutorial.adoc index 8bac57346ef3e..57cc8b870a00e 100644 --- a/docs/src/main/asciidoc/telemetry-micrometer-tutorial.adoc +++ b/docs/src/main/asciidoc/telemetry-micrometer-tutorial.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// [id="tutorial-micrometer"] = Collect metrics using Micrometer -include::./attributes.adoc[] +include::_attributes.adoc[] Create an application that uses the Micrometer metrics library to collect runtime, extension and application metrics and expose them as a Prometheus (OpenMetrics) endpoint. diff --git a/docs/src/main/asciidoc/tests-with-coverage.adoc b/docs/src/main/asciidoc/tests-with-coverage.adoc index 9091ae4140d32..d395f17a4522d 100644 --- a/docs/src/main/asciidoc/tests-with-coverage.adoc +++ b/docs/src/main/asciidoc/tests-with-coverage.adoc @@ -5,7 +5,7 @@ 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[] +include::_attributes.adoc[] :categories: tooling :summary: This guide explains how to measure the test coverage of your Quarkus application. :toc: macro diff --git a/docs/src/main/asciidoc/tooling.adoc b/docs/src/main/asciidoc/tooling.adoc index 1796ef60de78b..7f6900e259f44 100644 --- a/docs/src/main/asciidoc/tooling.adoc +++ b/docs/src/main/asciidoc/tooling.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using our Tooling -include::./attributes.adoc[] +include::_attributes.adoc[] :categories: getting-started :summary: Explore the Quarkus developer toolchain which makes Quarkus development so fast and enjoyable. diff --git a/docs/src/main/asciidoc/transaction.adoc b/docs/src/main/asciidoc/transaction.adoc index 64ad9f91688d2..a86d9d1f03d9c 100644 --- a/docs/src/main/asciidoc/transaction.adoc +++ b/docs/src/main/asciidoc/transaction.adoc @@ -4,7 +4,7 @@ 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[] +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. @@ -280,7 +280,7 @@ You cannot use `UserTransaction` in a method having a transaction started by a ` == Configuring the transaction timeout You can configure the default transaction timeout, the timeout that applies to all transactions managed by the transaction manager, via the property `quarkus.transaction-manager.default-transaction-timeout`, specified as a duration. -include::duration-format-note.adoc[] +include::{includes}/duration-format-note.adoc[] The default value is 60 seconds. diff --git a/docs/src/main/asciidoc/upx.adoc b/docs/src/main/asciidoc/upx.adoc index f46077dbcc54f..b973e0f6d959a 100644 --- a/docs/src/main/asciidoc/upx.adoc +++ b/docs/src/main/asciidoc/upx.adoc @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Compressing native executables using UPX -include::./attributes.adoc[] +include::_attributes.adoc[] https://upx.github.io/[Ultimate Packer for eXecutables (UPX)] is a compression tool reducing the size of executables. Quarkus can compress the produced native executable to reduce its size. diff --git a/docs/src/main/asciidoc/validation.adoc b/docs/src/main/asciidoc/validation.adoc index fda8cac26c4e2..808b0e9ced178 100644 --- a/docs/src/main/asciidoc/validation.adoc +++ b/docs/src/main/asciidoc/validation.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: web, data :summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services. diff --git a/docs/src/main/asciidoc/vertx-reference.adoc b/docs/src/main/asciidoc/vertx-reference.adoc index 6737fd1ceac07..9f65e43ff7baf 100644 --- a/docs/src/main/asciidoc/vertx-reference.adoc +++ b/docs/src/main/asciidoc/vertx-reference.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/src/main/asciidoc/vertx.adoc b/docs/src/main/asciidoc/vertx.adoc index 635c94fb0d800..15a755f366e4b 100644 --- a/docs/src/main/asciidoc/vertx.adoc +++ b/docs/src/main/asciidoc/vertx.adoc @@ -4,7 +4,7 @@ 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[] +include::_attributes.adoc[] :categories: miscellaneous :summary: This guide explains how to use Vert.x in Quarkus to build reactive applications. diff --git a/docs/src/main/asciidoc/virtual-threads.adoc b/docs/src/main/asciidoc/virtual-threads.adoc index e55f24476308e..9e1197cd8e840 100644 --- a/docs/src/main/asciidoc/virtual-threads.adoc +++ b/docs/src/main/asciidoc/virtual-threads.adoc @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Writing simpler reactive REST services with Quarkus Virtual Thread support -include::./attributes.adoc[] +include::_attributes.adoc[] :resteasy-reactive-api: https://javadoc.io/doc/io.quarkus.resteasy.reactive/resteasy-reactive/{quarkus-version} :resteasy-reactive-common-api: https://javadoc.io/doc/io.quarkus.resteasy.reactive/resteasy-reactive-common/{quarkus-version} :runonvthread: https://javadoc.io/doc/io.smallrye.common/smallrye-common-annotation/latest/io/smallrye/common/annotation/RunOnVirtualThread.html diff --git a/docs/src/main/asciidoc/websockets.adoc b/docs/src/main/asciidoc/websockets.adoc index 43070e66356a2..9ac772c40a532 100644 --- a/docs/src/main/asciidoc/websockets.adoc +++ b/docs/src/main/asciidoc/websockets.adoc @@ -4,7 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using WebSockets -include::./attributes.adoc[] +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. diff --git a/docs/src/main/asciidoc/writing-extensions.adoc b/docs/src/main/asciidoc/writing-extensions.adoc index d1c07c628ad9a..662198cdf24ae 100644 --- a/docs/src/main/asciidoc/writing-extensions.adoc +++ b/docs/src/main/asciidoc/writing-extensions.adoc @@ -11,7 +11,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc :sectnumlevels: 4 :toc: -include::./attributes.adoc[] +include::_attributes.adoc[] Quarkus extensions add a new developer focused behavior to the core offering, and consist of two distinct parts, buildtime augmentation and runtime container. The augmentation part is responsible for all metadata processing, such as reading annotations, XML descriptors etc. The output of this augmentation phase is recorded bytecode which is responsible for directly instantiating the relevant runtime services. diff --git a/docs/src/main/asciidoc/writing-native-applications-tips.adoc b/docs/src/main/asciidoc/writing-native-applications-tips.adoc index 95d602083804f..997276d1cd413 100644 --- a/docs/src/main/asciidoc/writing-native-applications-tips.adoc +++ b/docs/src/main/asciidoc/writing-native-applications-tips.adoc @@ -4,7 +4,7 @@ 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[] +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. diff --git a/docs/sync-web-site.sh b/docs/sync-web-site.sh index 708399d683033..94690c129d300 100755 --- a/docs/sync-web-site.sh +++ b/docs/sync-web-site.sh @@ -47,7 +47,7 @@ echo "Copying from target/asciidoc/sources/* to $TARGET_GUIDES" rsync -vr --delete \ --exclude='**/*.html' \ --exclude='**/index.adoc' \ - --exclude='**/attributes-local.adoc' \ + --exclude='**/_attributes-local.adoc' \ --exclude='**/guides.md' \ --exclude='**/_templates' \ target/asciidoc/sources/* \ @@ -57,7 +57,7 @@ echo "\nCopying from ../target/asciidoc/generated/ to $TARGET_CONFIG" rsync -vr --delete \ --exclude='**/*.html' \ --exclude='**/index.adoc' \ - --exclude='**/attributes.adoc' \ + --exclude='**/_attributes.adoc' \ ../target/asciidoc/generated/ \ $TARGET_CONFIG