Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 6, 2023
1 parent b989277 commit a7e7d97
Show file tree
Hide file tree
Showing 93 changed files with 8,379 additions and 282 deletions.
20 changes: 10 additions & 10 deletions _data/versioned/main/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ types:
- title: Configure data sources in Quarkus
filename: datasource.adoc
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
categories: "data, getting-started"
categories: "getting-started, data"
id: datasources
type: reference
url: /guides/datasource
Expand All @@ -55,7 +55,7 @@ types:
- title: Logging configuration
filename: logging.adoc
summary: "Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs."
categories: "observability, core, getting-started"
categories: "core, observability, getting-started"
id: logging
type: reference
url: /guides/logging
Expand Down Expand Up @@ -180,7 +180,7 @@ types:
- title: "Duplicated context, context locals, asynchronous processing and propagation"
filename: duplicated-context.adoc
summary: "When using a traditional, blocking, and synchronous framework, processing of each request is performed in a dedicated thread."
categories: "architecture, core"
categories: "core, architecture"
id: duplicated-context
type: concepts
url: /guides/duplicated-context
Expand Down Expand Up @@ -273,7 +273,7 @@ types:
- title: Building a Native Executable
filename: building-native-image.adoc
summary: Build native executables with GraalVM or Mandrel.
categories: "native, getting-started"
categories: "getting-started, native"
type: tutorial
url: /guides/building-native-image
- title: Collect metrics using Micrometer
Expand Down Expand Up @@ -325,7 +325,7 @@ types:
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
filename: security-basic-authentication-tutorial.adoc
summary: Secure your Quarkus application endpoints by combining the built-in Quarkus Basic authentication with the Jakarta Persistence identity provider to enable role-based access control (RBAC).
categories: "security, getting-started"
categories: "getting-started, security"
id: security-basic-authentication-tutorial
type: tutorial
url: /guides/security-basic-authentication-tutorial
Expand All @@ -338,7 +338,7 @@ types:
- title: Your second Quarkus application
filename: getting-started-dev-services.adoc
summary: This tutorial shows you how to create an application which writes to and reads from a database.
categories: "core, data, getting-started"
categories: "core, getting-started, data"
id: getting-started-dev-services-tutorial
type: tutorial
url: /guides/getting-started-dev-services
Expand Down Expand Up @@ -1033,7 +1033,7 @@ types:
- title: Simplified Hibernate ORM with Panache and Kotlin
filename: hibernate-orm-panache-kotlin.adoc
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
categories: "data, alt-languages"
categories: "alt-languages, data"
type: guide
url: /guides/hibernate-orm-panache-kotlin
- title: Simplified Hibernate Reactive with Panache
Expand All @@ -1051,7 +1051,7 @@ types:
- title: Simplified MongoDB with Panache and Kotlin
filename: mongodb-panache-kotlin.adoc
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
categories: "data, alt-languages"
categories: "alt-languages, data"
type: guide
url: /guides/mongodb-panache-kotlin
- title: SmallRye Fault Tolerance
Expand Down Expand Up @@ -1336,13 +1336,13 @@ types:
- title: Validation with Hibernate Validator
filename: validation.adoc
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
categories: "data, web"
categories: "web, data"
type: guide
url: /guides/validation
- title: Writing JSON REST Services
filename: rest-json.adoc
summary: JSON is now the lingua franca between microservices.
categories: "web, serialization"
categories: "serialization, web"
type: guide
url: /guides/rest-json
- title: Writing REST Services with RESTEasy Reactive
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":".network","additionalKeys":[],"configDoc":"Controls the container network to be used when @QuarkusIntegration needs to launch the application in a container. This setting only applies if Quarkus does not need to use a shared network - which is the case if DevServices are used when running the test.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".additional-exposed-ports","additionalKeys":[],"configDoc":"Set additional ports to be exposed when @QuarkusIntegration needs to launch the application in a container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-exposed-ports","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".labels","additionalKeys":[],"configDoc":"A set of labels to add to the launched container","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"labels","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":"","additionalKeys":[],"configDoc":"The profile (dev, test or prod) to use when testing using @QuarkusTest","withinAMap":false,"defaultValue":"test","javaDocSiteLink":"","docMapKey":"profile","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tags","additionalKeys":[],"configDoc":"The tags this profile is associated with. When the `quarkus.test.profile.tags` System property is set (its value is a comma separated list of strings) then Quarkus will only execute tests that are annotated with a `@TestProfile` that has at least one of the supplied (via the aforementioned system property) tags.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tags","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":".group-id","additionalKeys":[],"configDoc":"The maven groupId of the artifact.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"group-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".artifact-id","additionalKeys":[],"configDoc":"The maven artifactId of the artifact.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifact-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".classifier","additionalKeys":[],"configDoc":"The maven classifier of the artifact.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"classifier","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"boolean","key":".add-implementation-entries","additionalKeys":[],"configDoc":"If the Implementation information should be included in the runner jar's MANIFEST.MF.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-implementation-entries","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".attributes","additionalKeys":[],"configDoc":"Custom manifest attributes to be added to the main section of the MANIFEST.MF file. An example of the user defined property: quarkus.package.manifest.attributes.\"Entry-key1\"=Value1 quarkus.package.manifest.attributes.\"Entry-key2\"=Value2","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"attributes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,Map<String,String>>`","key":".manifest-sections","additionalKeys":[],"configDoc":"Custom manifest sections to be added to the MANIFEST.MF file. An example of the user defined property: quarkus.package.manifest.manifest-sections.\"Section-Name\".\"Entry-Key1\"=Value1 quarkus.package.manifest.manifest-sections.\"Section-Name\".\"Entry-Key2\"=Value2","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"manifest-sections","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":"","additionalKeys":[],"configDoc":"The docker image to use to do the image build. It can be one of `graalvm`, `mandrel`, or the full image path, e.g. `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-17`.","withinAMap":false,"defaultValue":"mandrel","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.deployment.pkg.NativeConfig.ImagePullStrategy","key":".pull","additionalKeys":[],"configDoc":"The strategy for pulling the builder image during the build.\n\nDefaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated.\n\nUse 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited.\n\nUse 'never' to fail the build if there is no image locally.","withinAMap":false,"defaultValue":"always","javaDocSiteLink":"","docMapKey":"pull","configPhase":"BUILD_TIME","acceptedValues":["`always`","`missing`","`never`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"java.lang.Integer","key":".level","additionalKeys":[],"configDoc":"The compression level in ++[++1, 10++]++. 10 means _best_.\n\nHigher compression level requires more time to compress the executable.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"level","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".additional-args","additionalKeys":[],"configDoc":"Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod].","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":".includes","additionalKeys":[],"configDoc":"A comma separated list of globs to match resource paths that should be added to the native image.\n\nUse slash (`/`) as a path separator on all platforms. Globs must not start with slash.\n\nBy default, no resources are included.\n\nExample: Given that you have `src/main/resources/ignored.png` and `src/main/resources/foo/selected.png` in your source tree and one of your dependency JARs contains `bar/some.txt` file, with the following configuration\n\n```\nquarkus.native.resources.includes = foo/**,bar/**/*.txt\n```\n\nthe files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included.\n\nSupported glob features Feature Description `++*++` Matches a (possibly empty) sequence of characters that does not contain slash (`/`) `++**++` Matches a (possibly empty) sequence of characters that may contain slash (`/`) `?` Matches one character, but not slash `++[++abc++]++` Matches one character given in the bracket, but not slash `++[++a-z++]++` Matches one character from the range given in the bracket, but not slash `++[++!abc++]++` Matches one character not named in the bracket; does not match slash `++[++a-z++]++` Matches one character outside the range given in the bracket; does not match slash `++{++one,two,three++}++` Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges `++\\++` The escape character\n\nNote that there are three levels of escaping when passing this option via `application.properties`:\n\n . `application.properties` parser\n - MicroProfile Config list converter that splits the comma separated list\n - Glob parser All three levels use backslash (`++\\++`) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape.\n\nNote that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"includes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".excludes","additionalKeys":[],"configDoc":"A comma separated list of globs to match resource paths that should *not* be added to the native image.\n\nUse slash (`/`) as a path separator on all platforms. Globs must not start with slash.\n\nPlease refer to `includes` for details about the glob syntax.\n\nBy default, no resources are excluded.\n\nExample: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration\n\n```\nquarkus.native.resources.includes = **/*.png\nquarkus.native.resources.excludes = foo/**,**/green.png\n```\n\nthe resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"excludes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"An advanced option that will decompile generated and transformed bytecode into the 'decompiled' directory. This is only taken into account when fast-jar is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".version","additionalKeys":[],"configDoc":"The version of Quiltflower to use","withinAMap":false,"defaultValue":"1.8.1","javaDocSiteLink":"","docMapKey":"version","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jar-directory","additionalKeys":[],"configDoc":"The directory into which to save the Quiltflower tool if it doesn't exist","withinAMap":false,"defaultValue":"${user.home}/.quarkus","javaDocSiteLink":"","docMapKey":"jar-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Loading

0 comments on commit a7e7d97

Please sign in to comment.