Skip to content

Commit 2d70a40

Browse files
author
quarkusbot
committed
Sync web site with Quarkus documentation
1 parent bfacdaa commit 2d70a40

File tree

47 files changed

+1587
-774
lines changed

Some content is hidden

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

47 files changed

+1587
-774
lines changed

_data/versioned/latest/index/quarkus.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,7 @@ types:
305305
- title: Vert.x Reference Guide
306306
filename: vertx-reference.adoc
307307
summary: This reference guide provides advanced details about the usage and the configuration of the Vert.x instance used by Quarkus.
308+
keywords: vertx event verticle
308309
categories: miscellaneous
309310
type: reference
310311
url: /guides/vertx-reference
@@ -2271,6 +2272,7 @@ types:
22712272
- title: Using Eclipse Vert.x API from a Quarkus Application
22722273
filename: vertx.adoc
22732274
summary: This guide explains how to use Vert.x in Quarkus to build reactive applications.
2275+
keywords: vertx event verticle
22742276
categories: miscellaneous
22752277
type: guide
22762278
url: /guides/vertx
@@ -2646,6 +2648,7 @@ types:
26462648
- title: Using the event bus
26472649
filename: reactive-event-bus.adoc
26482650
summary: This guide explains how different beans can interact using the event bus.
2651+
keywords: vertx vert.x
26492652
categories: messaging
26502653
topics:
26512654
- messaging

_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.client.OidcClientConfig

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.common.runtime.OidcCommonConfig

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.common.runtime.OidcCommonConfig.Credentials

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":"string","key":".value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'secret.key' is set","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".provider","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Provider","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":".method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"BUILD_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}]
1+
[{"configDocKey":{"type":"string","key":".value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'credentials.secret' is set","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".provider","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Provider","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":".method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"BUILD_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"java.util.regex.Pattern","key":".no-restart-templates","additionalKeys":[],"configDoc":"By default, a template modification results in an application restart that triggers build-time validations.\n\nThis regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.\n\nThe matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"no-restart-templates","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"java.util.regex.Pattern","key":".no-restart-templates","additionalKeys":[],"configDoc":"By default, a template modification results in an application restart that triggers build-time validations.\n\nThis regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.\n\nThe matched input is the template path that starts with a template root, and the `/` is used as a path separator. For example, `templates/foo.html`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"no-restart-templates","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.oidc.client.runtime.OidcClientsConfig

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

_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig

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":"string","key":"quarkus.qute.suffixes","additionalKeys":[],"configDoc":"The list of suffixes used when attempting to locate a template file.\n\nBy default, `engine.getTemplate(\"foo\")` would result in several lookups: `foo`, `foo.html`, `foo.txt`, etc.","withinAMap":false,"defaultValue":"qute.html,qute.txt,html,txt","javaDocSiteLink":"","docMapKey":"suffixes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":"quarkus.qute.content-types","additionalKeys":[],"configDoc":"The additional map of suffixes to content types. This map is used when working with template variants. By default, the `java.net.URLConnection++#++getFileNameMap()` is used to determine the content type of a template file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.type-check-excludes","additionalKeys":[],"configDoc":"The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation.\n\nAn element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value `++*++` can be used to match any name.\n\nExamples:\n\n - `org.acme.Foo.name` - exclude the property/method `name` on the `org.acme.Foo` class\n - `org.acme.Foo.++*++` - exclude any property/method on the `org.acme.Foo` class\n - `++*++.age` - exclude the property/method `age` on any class","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"type-check-excludes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.qute.template-path-exclude","additionalKeys":[],"configDoc":"This regular expression is used to exclude template files from the `templates` directory. Excluded templates are neither parsed nor validated during build and are not available at runtime.\n\nThe matched input is the file path relative from the `templates` directory and the `/` is used as a path separator.\n\nBy default, the hidden files are excluded. The name of a hidden file starts with a dot.","withinAMap":false,"defaultValue":"^\\..*|.*\\/\\..*$","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"template-path-exclude","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.iteration-metadata-prefix","additionalKeys":[],"configDoc":"The prefix is used to access the iteration metadata inside a loop section.\n\nA valid prefix consists of alphanumeric characters and underscores. Three special constants can be used:\n\n - `<alias_>` - the alias of an iterated element suffixed with an underscore is used, e.g. `item_hasNext` and `it_count`\n - `<alias?>` - the alias of an iterated element suffixed with a question mark is used, e.g. `item?hasNext` and `it?count`\n - `<none>` - no prefix is used, e.g. `hasNext` and `count` By default, the `<alias_>` constant is set.","withinAMap":false,"defaultValue":"<alias_>","javaDocSiteLink":"","docMapKey":"iteration-metadata-prefix","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.escape-content-types","additionalKeys":[],"configDoc":"The list of content types for which the `'`, `\"`, `<`, `>` and `&` characters are escaped if a template variant is set.","withinAMap":false,"defaultValue":"text/html,text/xml,application/xml,application/xhtml+xml","javaDocSiteLink":"","docMapKey":"escape-content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.qute.default-charset","additionalKeys":[],"configDoc":"The default charset of the templates files.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"default-charset","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.qute.dev-mode.no-restart-templates","additionalKeys":[],"configDoc":"By default, a template modification results in an application restart that triggers build-time validations.\n\nThis regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.\n\nThe matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"no-restart-templates","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.qute","enum":false}}]
1+
[{"configDocKey":{"type":"string","key":"quarkus.qute.suffixes","additionalKeys":[],"configDoc":"The list of suffixes used when attempting to locate a template file.\n\nBy default, `engine.getTemplate(\"foo\")` would result in several lookups: `foo`, `foo.html`, `foo.txt`, etc.","withinAMap":false,"defaultValue":"qute.html,qute.txt,html,txt","javaDocSiteLink":"","docMapKey":"suffixes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":"quarkus.qute.content-types","additionalKeys":[],"configDoc":"The additional map of suffixes to content types. This map is used when working with template variants. By default, the `java.net.URLConnection++#++getFileNameMap()` is used to determine the content type of a template file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.type-check-excludes","additionalKeys":[],"configDoc":"The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation.\n\nAn element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value `++*++` can be used to match any name.\n\nExamples:\n\n - `org.acme.Foo.name` - exclude the property/method `name` on the `org.acme.Foo` class\n - `org.acme.Foo.++*++` - exclude any property/method on the `org.acme.Foo` class\n - `++*++.age` - exclude the property/method `age` on any class","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"type-check-excludes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.qute.template-path-exclude","additionalKeys":[],"configDoc":"This regular expression is used to exclude template files from the `templates` directory. Excluded templates are neither parsed nor validated during build and are not available at runtime.\n\nThe matched input is the file path relative from the `templates` directory and the `/` is used as a path separator.\n\nBy default, the hidden files are excluded. The name of a hidden file starts with a dot.","withinAMap":false,"defaultValue":"^\\..*|.*\\/\\..*$","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"template-path-exclude","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.iteration-metadata-prefix","additionalKeys":[],"configDoc":"The prefix is used to access the iteration metadata inside a loop section.\n\nA valid prefix consists of alphanumeric characters and underscores. Three special constants can be used:\n\n - `<alias_>` - the alias of an iterated element suffixed with an underscore is used, e.g. `item_hasNext` and `it_count`\n - `<alias?>` - the alias of an iterated element suffixed with a question mark is used, e.g. `item?hasNext` and `it?count`\n - `<none>` - no prefix is used, e.g. `hasNext` and `count` By default, the `<alias_>` constant is set.","withinAMap":false,"defaultValue":"<alias_>","javaDocSiteLink":"","docMapKey":"iteration-metadata-prefix","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.escape-content-types","additionalKeys":[],"configDoc":"The list of content types for which the `'`, `\"`, `<`, `>` and `&` characters are escaped if a template variant is set.","withinAMap":false,"defaultValue":"text/html,text/xml,application/xml,application/xhtml+xml","javaDocSiteLink":"","docMapKey":"escape-content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.qute.default-charset","additionalKeys":[],"configDoc":"The default charset of the templates files.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"default-charset","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.qute.dev-mode.no-restart-templates","additionalKeys":[],"configDoc":"By default, a template modification results in an application restart that triggers build-time validations.\n\nThis regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.\n\nThe matched input is the template path that starts with a template root, and the `/` is used as a path separator. For example, `templates/foo.html`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"no-restart-templates","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.qute","enum":false}}]

0 commit comments

Comments
 (0)