Skip to content

Commit 7510026

Browse files
committed
Sync web site with Quarkus documentation
1 parent 40010fc commit 7510026

File tree

219 files changed

+3391
-1092
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

219 files changed

+3391
-1092
lines changed

_data/versioned/latest/index/quarkus.yaml

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ types:
3030
- title: Configure data sources in Quarkus
3131
filename: datasource.adoc
3232
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
33-
categories: "data, getting-started"
33+
categories: "getting-started, data"
3434
id: datasources
3535
type: reference
3636
url: /guides/datasource
@@ -170,10 +170,17 @@ types:
170170
id: security-basic-authentication
171171
type: concepts
172172
url: /guides/security-basic-authentication
173+
- title: Configuring Well-Known OpenID Connect Providers
174+
filename: security-openid-connect-providers.adoc
175+
summary: This document explains how to configure well-known social OIDC and OAuth2 providers.
176+
categories: "security, web"
177+
id: security-openid-connect-providers
178+
type: concepts
179+
url: /guides/security-openid-connect-providers
173180
- title: "Duplicated context, context locals, asynchronous processing and propagation"
174181
filename: duplicated-context.adoc
175182
summary: "When using a traditional, blocking, and synchronous framework, processing of each request is performed in a dedicated thread."
176-
categories: "core, architecture"
183+
categories: "architecture, core"
177184
id: duplicated-context
178185
type: concepts
179186
url: /guides/duplicated-context
@@ -331,7 +338,7 @@ types:
331338
- title: Your second Quarkus application
332339
filename: getting-started-dev-services.adoc
333340
summary: This tutorial shows you how to create an application which writes to and reads from a database.
334-
categories: "core, data, getting-started"
341+
categories: "core, getting-started, data"
335342
id: getting-started-dev-services-tutorial
336343
type: tutorial
337344
url: /guides/getting-started-dev-services
@@ -477,10 +484,6 @@ types:
477484
categories: writing-extensions
478485
type: guide
479486
url: /guides/conditional-extension-dependencies
480-
- title: Configuring Well-Known OpenID Connect Providers
481-
filename: security-openid-connect-providers.adoc
482-
type: guide
483-
url: /guides/security-openid-connect-providers
484487
- title: Configuring Your Application
485488
filename: config.adoc
486489
summary: Hardcoded values in your code is a no go (even if we all did it at some point ;-)).
@@ -585,7 +588,8 @@ types:
585588
url: /guides/databases-dev-services
586589
- title: Dev Services for Elasticsearch
587590
filename: elasticsearch-dev-services.adoc
588-
summary: If any Elasticsearch-related extension is present (e.g.
591+
summary: Start Elasticsearch automatically in dev and test modes
592+
categories: data
589593
type: guide
590594
url: /guides/elasticsearch-dev-services
591595
- title: Dev Services for Infinispan
@@ -948,14 +952,14 @@ types:
948952
- title: Quarkus and Gradle
949953
filename: gradle-tooling.adoc
950954
summary: Develop and build your Quarkus application with Gradle
951-
categories: "tooling, native"
955+
categories: "native, tooling"
952956
id: gradle-tooling
953957
type: guide
954958
url: /guides/gradle-tooling
955959
- title: Quarkus and Maven
956960
filename: maven-tooling.adoc
957961
summary: Develop and build your Quarkus application with Maven
958-
categories: "tooling, native"
962+
categories: "native, tooling"
959963
id: maven-tooling
960964
type: guide
961965
url: /guides/maven-tooling
@@ -1053,7 +1057,7 @@ types:
10531057
- title: SmallRye Fault Tolerance
10541058
filename: smallrye-fault-tolerance.adoc
10551059
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
1056-
categories: "web, observability"
1060+
categories: "observability, web"
10571061
type: guide
10581062
url: /guides/smallrye-fault-tolerance
10591063
- title: SmallRye GraphQL
@@ -1083,7 +1087,7 @@ types:
10831087
- title: Testing Your Application
10841088
filename: getting-started-testing.adoc
10851089
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1086-
categories: "core, tooling, native"
1090+
categories: "core, native, tooling"
10871091
id: testing
10881092
type: guide
10891093
url: /guides/getting-started-testing
@@ -1338,7 +1342,7 @@ types:
13381342
- title: Writing JSON REST Services
13391343
filename: rest-json.adoc
13401344
summary: JSON is now the lingua franca between microservices.
1341-
categories: "web, serialization"
1345+
categories: "serialization, web"
13421346
type: guide
13431347
url: /guides/rest-json
13441348
- title: Writing REST Services with RESTEasy Reactive

_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.flyway.runtime.FlywayDataSourceRuntimeConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.GrpcClientConfiguration

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Authentication

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Token

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: `redis/redis-stack-server:latest`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the Redis server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Redis starts a new container.\n\nThe discovery uses the `quarkus-dev-service-redis` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-redis` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Redis looks for a container with the `quarkus-dev-service-redis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-redis` label set to the specified value.\n\nThis property is used when you need multiple shared Redis servers.","withinAMap":false,"defaultValue":"redis","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: `redis/redis-stack:latest`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the Redis server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Redis starts a new container.\n\nThe discovery uses the `quarkus-dev-service-redis` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-redis` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Redis looks for a container with the `quarkus-dev-service-redis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-redis` label set to the specified value.\n\nThis property is used when you need multiple shared Redis servers.","withinAMap":false,"defaultValue":"redis","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".devservices","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.redis.deployment.client.DevServicesConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".devservices.image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: `redis/redis-stack-server:latest`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Redis server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Redis starts a new container.\n\nThe discovery uses the `quarkus-dev-service-redis` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-redis` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Redis looks for a container with the `quarkus-dev-service-redis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-redis` label set to the specified value.\n\nThis property is used when you need multiple shared Redis servers.","withinAMap":false,"defaultValue":"redis","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".devservices.container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}]
1+
[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".devservices","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.redis.deployment.client.DevServicesConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".devservices.image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: `redis/redis-stack:latest`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Redis server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Redis starts a new container.\n\nThe discovery uses the `quarkus-dev-service-redis` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-redis` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Redis looks for a container with the `quarkus-dev-service-redis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-redis` label set to the specified value.\n\nThis property is used when you need multiple shared Redis servers.","withinAMap":false,"defaultValue":"redis","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".devservices.container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}]

0 commit comments

Comments
 (0)