Skip to content

Commit d0596c9

Browse files
committed
Sync documentation of main branch
1 parent 95906e5 commit d0596c9

File tree

36 files changed

+682
-228
lines changed

36 files changed

+682
-228
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ types:
1818
- title: Command Mode Applications
1919
filename: command-mode-reference.adoc
2020
summary: This reference guide explains how to develop command line applications with Quarkus.
21-
categories: "command-line, core"
21+
categories: "core, command-line"
2222
type: reference
2323
url: /guides/command-mode-reference
2424
- title: Configuration Reference Guide
@@ -173,7 +173,7 @@ types:
173173
- title: "Duplicated context, context locals, asynchronous processing and propagation"
174174
filename: duplicated-context.adoc
175175
summary: "When using a traditional, blocking, and synchronous framework, processing of each request is performed in a dedicated thread."
176-
categories: "architecture, core"
176+
categories: "core, architecture"
177177
id: duplicated-context
178178
type: concepts
179179
url: /guides/duplicated-context
@@ -229,7 +229,7 @@ types:
229229
- title: Security vulnerability detection and reporting in Quarkus
230230
filename: security-vulnerability-detection.adoc
231231
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
232-
categories: "contributing, security"
232+
categories: "security, contributing"
233233
id: security-vulnerability-detection
234234
type: concepts
235235
url: /guides/security-vulnerability-detection
@@ -258,7 +258,7 @@ types:
258258
- title: Use virtual threads in REST applications
259259
filename: resteasy-reactive-virtual-threads.adoc
260260
summary: How to use virtual threads in a REST application
261-
categories: "web, core"
261+
categories: "core, web"
262262
id: resteasy-reactive-virtual-threads
263263
type: howto
264264
url: /guides/resteasy-reactive-virtual-threads
@@ -328,6 +328,13 @@ types:
328328
categories: getting-started
329329
type: tutorial
330330
url: /guides/tooling
331+
- title: Your second Quarkus application
332+
filename: getting-started-dev-services.adoc
333+
summary: This tutorial shows you how to create an application which writes to and reads from a database.
334+
categories: "getting-started, core, data"
335+
id: getting-started-dev-services-tutorial
336+
type: tutorial
337+
url: /guides/getting-started-dev-services
331338
guide:
332339
- title: AWS Lambda
333340
filename: aws-lambda.adoc
@@ -380,7 +387,7 @@ types:
380387
- title: AppCDS
381388
filename: appcds.adoc
382389
summary: This reference guide explains how to enable AppCDS with Quarkus.
383-
categories: "cloud, core"
390+
categories: "core, cloud"
384391
type: guide
385392
url: /guides/appcds
386393
- title: Application Data Caching
@@ -573,7 +580,7 @@ types:
573580
- title: Dev Services for Databases
574581
filename: databases-dev-services.adoc
575582
summary: "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."
576-
categories: "tooling, data"
583+
categories: "data, tooling"
577584
type: guide
578585
url: /guides/databases-dev-services
579586
- title: Dev Services for Elasticsearch
@@ -941,14 +948,14 @@ types:
941948
- title: Quarkus and Gradle
942949
filename: gradle-tooling.adoc
943950
summary: Develop and build your Quarkus application with Gradle
944-
categories: "tooling, native"
951+
categories: "native, tooling"
945952
id: gradle-tooling
946953
type: guide
947954
url: /guides/gradle-tooling
948955
- title: Quarkus and Maven
949956
filename: maven-tooling.adoc
950957
summary: Develop and build your Quarkus application with Maven
951-
categories: "tooling, native"
958+
categories: "native, tooling"
952959
id: maven-tooling
953960
type: guide
954961
url: /guides/maven-tooling
@@ -1022,7 +1029,7 @@ types:
10221029
- title: Simplified Hibernate ORM with Panache and Kotlin
10231030
filename: hibernate-orm-panache-kotlin.adoc
10241031
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
1025-
categories: "alt-languages, data"
1032+
categories: "data, alt-languages"
10261033
type: guide
10271034
url: /guides/hibernate-orm-panache-kotlin
10281035
- title: Simplified Hibernate Reactive with Panache
@@ -1040,13 +1047,13 @@ types:
10401047
- title: Simplified MongoDB with Panache and Kotlin
10411048
filename: mongodb-panache-kotlin.adoc
10421049
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
1043-
categories: "alt-languages, data"
1050+
categories: "data, alt-languages"
10441051
type: guide
10451052
url: /guides/mongodb-panache-kotlin
10461053
- title: SmallRye Fault Tolerance
10471054
filename: smallrye-fault-tolerance.adoc
10481055
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
1049-
categories: "observability, web"
1056+
categories: "web, observability"
10501057
type: guide
10511058
url: /guides/smallrye-fault-tolerance
10521059
- title: SmallRye GraphQL
@@ -1076,14 +1083,14 @@ types:
10761083
- title: Testing Your Application
10771084
filename: getting-started-testing.adoc
10781085
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1079-
categories: "tooling, native, core"
1086+
categories: "core, native, tooling"
10801087
id: testing
10811088
type: guide
10821089
url: /guides/getting-started-testing
10831090
- title: Tips for writing native applications
10841091
filename: writing-native-applications-tips.adoc
10851092
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1086-
categories: "native, core, writing-extensions"
1093+
categories: "writing-extensions, core, native"
10871094
type: guide
10881095
url: /guides/writing-native-applications-tips
10891096
- title: Using Apache Kafka Streams
@@ -1212,7 +1219,7 @@ types:
12121219
- title: Using SSL With Native Executables
12131220
filename: native-and-ssl.adoc
12141221
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."
1215-
categories: "native, security, core"
1222+
categories: "core, security, native"
12161223
type: guide
12171224
url: /guides/native-and-ssl
12181225
- title: Using Security with .properties File
@@ -1325,13 +1332,13 @@ types:
13251332
- title: Validation with Hibernate Validator
13261333
filename: validation.adoc
13271334
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1328-
categories: "web, data"
1335+
categories: "data, web"
13291336
type: guide
13301337
url: /guides/validation
13311338
- title: Writing JSON REST Services
13321339
filename: rest-json.adoc
13331340
summary: JSON is now the lingua franca between microservices.
1334-
categories: "web, serialization"
1341+
categories: "serialization, web"
13351342
type: guide
13361343
url: /guides/rest-json
13371344
- title: Writing REST Services with RESTEasy Reactive
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":"","additionalKeys":[],"configDoc":"Determine whether to enable the JSON console formatting extension, which disables \"normal\" console formatting.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".pretty-print","additionalKeys":[],"configDoc":"Enable \"pretty printing\" of the JSON record. Note that some JSON parsers will fail to read pretty printed output.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pretty-print","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".date-format","additionalKeys":[],"configDoc":"The date format to use. The special string \"default\" indicates that the default format should be used.","withinAMap":false,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"date-format","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".record-delimiter","additionalKeys":[],"configDoc":"The special end-of-record delimiter to be used. By default, newline is used as delimiter.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"record-delimiter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".zone-id","additionalKeys":[],"configDoc":"The zone ID to use. The special string \"default\" indicates that the default zone should be used.","withinAMap":false,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"zone-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"org.jboss.logmanager.formatters.StructuredFormatter.ExceptionOutputType","key":".exception-output-type","additionalKeys":[],"configDoc":"The exception output type to specify.","withinAMap":false,"defaultValue":"detailed","javaDocSiteLink":"","docMapKey":"exception-output-type","configPhase":"BUILD_TIME","acceptedValues":["`detailed`","`formatted`","`detailed-and-formatted`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".print-details","additionalKeys":[],"configDoc":"Enable printing of more details in the log.\n\nPrinting the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name and source line number.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"print-details","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-overrides","additionalKeys":[],"configDoc":"Override keys with custom values. Omitting this value indicates that no key overrides will be applied.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-overrides","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".excluded-keys","additionalKeys":[],"configDoc":"Keys to be excluded from the Json output.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"excluded-keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".additional-field.\"field-name\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.logging.json.runtime.AdditionalFieldConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".additional-field.\"field-name\".value","additionalKeys":[],"configDoc":"Additional field value.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.logging.json.runtime.AdditionalFieldConfig.Type","key":".additional-field.\"field-name\".type","additionalKeys":[],"configDoc":"Additional field type specification. Supported types: string, int, long String is the default if not specified.","withinAMap":true,"defaultValue":"string","javaDocSiteLink":"","docMapKey":"type","configPhase":"BUILD_TIME","acceptedValues":["`string`","`int`","`long`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}],"anchorPrefix":null}}]
1+
[{"configDocKey":{"type":"boolean","key":"","additionalKeys":[],"configDoc":"Determine whether to enable the JSON console formatting extension, which disables \"normal\" console formatting.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".pretty-print","additionalKeys":[],"configDoc":"Enable \"pretty printing\" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pretty-print","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".date-format","additionalKeys":[],"configDoc":"The date format to use. The special string \"default\" indicates that the default format should be used.","withinAMap":false,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"date-format","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".record-delimiter","additionalKeys":[],"configDoc":"The special end-of-record delimiter to be used. By default, newline is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"record-delimiter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".zone-id","additionalKeys":[],"configDoc":"The zone ID to use. The special string \"default\" indicates that the default zone should be used.","withinAMap":false,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"zone-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"org.jboss.logmanager.formatters.StructuredFormatter.ExceptionOutputType","key":".exception-output-type","additionalKeys":[],"configDoc":"The exception output type to specify.","withinAMap":false,"defaultValue":"detailed","javaDocSiteLink":"","docMapKey":"exception-output-type","configPhase":"BUILD_TIME","acceptedValues":["`detailed`","`formatted`","`detailed-and-formatted`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".print-details","additionalKeys":[],"configDoc":"Enable printing of more details in the log.\n\nPrinting the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"print-details","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-overrides","additionalKeys":[],"configDoc":"Override keys with custom values. Omitting this value indicates that no key overrides will be applied.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-overrides","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".excluded-keys","additionalKeys":[],"configDoc":"Keys to be excluded from the JSON output.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"excluded-keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".additional-field.\"field-name\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.logging.json.runtime.AdditionalFieldConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".additional-field.\"field-name\".value","additionalKeys":[],"configDoc":"Additional field value.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.logging.json.runtime.AdditionalFieldConfig.Type","key":".additional-field.\"field-name\".type","additionalKeys":[],"configDoc":"Additional field type specification. Supported types: string, int, long String is the default if not specified.","withinAMap":true,"defaultValue":"string","javaDocSiteLink":"","docMapKey":"type","configPhase":"BUILD_TIME","acceptedValues":["`string`","`int`","`long`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}],"anchorPrefix":null}}]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"io.quarkus.runtime.logging.InheritableLevel","key":".min-level","additionalKeys":[],"configDoc":"The minimum log level for this category. By default, all categories are configured with `DEBUG` minimum level. To get runtime logging below `DEBUG`, e.g. `TRACE`, the minimum level has to be adjusted at build time, the right log level needs to be provided at runtime. As an example, to get `TRACE` logging, minimum level needs to be at `TRACE` and the runtime log level needs to match that.","withinAMap":false,"defaultValue":"inherit","javaDocSiteLink":"","docMapKey":"min-level","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"io.quarkus.runtime.logging.InheritableLevel","key":".min-level","additionalKeys":[],"configDoc":"The minimum log level for this category. By default, all categories are configured with `DEBUG` minimum level.\n\nTo get runtime logging below `DEBUG`, e.g., `TRACE`, adjust the minimum level at build time. The right log level needs to be provided at runtime.\n\nAs an example, to get `TRACE` logging, minimum level needs to be at `TRACE`, and the runtime log level needs to match that.","withinAMap":false,"defaultValue":"inherit","javaDocSiteLink":"","docMapKey":"min-level","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

0 commit comments

Comments
 (0)