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 1, 2023
1 parent a7603cf commit bd37b16
Show file tree
Hide file tree
Showing 19 changed files with 139 additions and 69 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 @@ -236,7 +236,7 @@ types:
- title: Security vulnerability detection and reporting in Quarkus
filename: security-vulnerability-detection.adoc
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
categories: "contributing, security"
categories: "security, contributing"
id: security-vulnerability-detection
type: concepts
url: /guides/security-vulnerability-detection
Expand Down Expand Up @@ -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: "getting-started, data, core"
categories: "data, core, getting-started"
id: getting-started-dev-services-tutorial
type: tutorial
url: /guides/getting-started-dev-services
Expand Down Expand Up @@ -528,7 +528,7 @@ types:
- title: Deploying on OpenShift
filename: deploying-to-openshift.adoc
summary: This guide covers how to deploy a native application on OpenShift.
categories: "native, cloud"
categories: "cloud, native"
id: deploy-openshift
type: guide
url: /guides/deploying-to-openshift
Expand Down Expand Up @@ -813,7 +813,7 @@ types:
- title: Kubernetes extension
filename: deploying-to-kubernetes.adoc
summary: This guide covers how to deploy a native application on Kubernetes.
categories: "native, cloud"
categories: "cloud, native"
id: deploy-kubernetes
type: guide
url: /guides/deploying-to-kubernetes
Expand Down Expand Up @@ -952,14 +952,14 @@ types:
- title: Quarkus and Gradle
filename: gradle-tooling.adoc
summary: Develop and build your Quarkus application with Gradle
categories: "native, tooling"
categories: "tooling, native"
id: gradle-tooling
type: guide
url: /guides/gradle-tooling
- title: Quarkus and Maven
filename: maven-tooling.adoc
summary: Develop and build your Quarkus application with Maven
categories: "native, tooling"
categories: "tooling, native"
id: maven-tooling
type: guide
url: /guides/maven-tooling
Expand Down Expand Up @@ -1057,7 +1057,7 @@ types:
- title: SmallRye Fault Tolerance
filename: smallrye-fault-tolerance.adoc
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
categories: "observability, web"
categories: "web, observability"
type: guide
url: /guides/smallrye-fault-tolerance
- title: SmallRye GraphQL
Expand Down Expand Up @@ -1087,14 +1087,14 @@ types:
- title: Testing Your Application
filename: getting-started-testing.adoc
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
categories: "core, native, tooling"
categories: "tooling, core, native"
id: testing
type: guide
url: /guides/getting-started-testing
- title: Tips for writing native applications
filename: writing-native-applications-tips.adoc
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
categories: "core, native, writing-extensions"
categories: "core, writing-extensions, native"
type: guide
url: /guides/writing-native-applications-tips
- title: Using Apache Kafka Streams
Expand Down Expand Up @@ -1223,7 +1223,7 @@ types:
- title: Using SSL With Native Executables
filename: native-and-ssl.adoc
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."
categories: "core, security, native"
categories: "security, core, native"
type: guide
url: /guides/native-and-ssl
- title: Using Security with .properties File
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"Whether metrics are published if a metrics extension is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdentifierQuotingStrategy","key":".strategy","additionalKeys":[],"configDoc":"Identifiers can be quoted using one of the available strategies.\n\nSet to `none` by default, meaning no identifiers will be quoted. If set to `all`, all identifiers and column definitions will be quoted. Additionally, setting it to `all-except-column-definitions` will skip the column definitions, which can usually be required when they exist, or else use the option `only-keywords` to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["`none`","`all`","`all-except-column-definitions`","`only-keywords`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}]

Large diffs are not rendered by default.

10 changes: 2 additions & 8 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13864,10 +13864,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down Expand Up @@ -14780,10 +14777,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

:summaryTableId: quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-metric
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference, cols="80,.^10,.^10"]
|===

h|[[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-metric_configuration]]link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-metric_configuration[Configuration property]

h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-metric_quarkus.hibernate-orm.metrics.enabled]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-metric_quarkus.hibernate-orm.metrics.enabled[quarkus.hibernate-orm.metrics.enabled]`


[.description]
--
Whether metrics are published if a metrics extension is enabled.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_METRICS_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_METRICS_ENABLED+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

:summaryTableId: quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit-hibernate-orm-config-persistence-unit-quote-identifiers
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference, cols="80,.^10,.^10"]
|===

h|[[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit-hibernate-orm-config-persistence-unit-quote-identifiers_configuration]]link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit-hibernate-orm-config-persistence-unit-quote-identifiers_configuration[Configuration property]

h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit-hibernate-orm-config-persistence-unit-quote-identifiers_quarkus.hibernate-orm.quote-identifiers.strategy]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit-hibernate-orm-config-persistence-unit-quote-identifiers_quarkus.hibernate-orm.quote-identifiers.strategy[quarkus.hibernate-orm.quote-identifiers.strategy]`


[.description]
--
Identifiers can be quoted using one of the available strategies.

Set to `none` by default, meaning no identifiers will be quoted. If set to `all`, all identifiers and column definitions will be quoted. Additionally, setting it to `all-except-column-definitions` will skip the column definitions, which can usually be required when they exist, or else use the option `only-keywords` to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit-hibernate-orm-config-persistence-unit-quote-identifiers_quarkus.hibernate-orm.-persistence-unit-name-.quote-identifiers.strategy]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit-hibernate-orm-config-persistence-unit-quote-identifiers_quarkus.hibernate-orm.-persistence-unit-name-.quote-identifiers.strategy[quarkus.hibernate-orm."persistence-unit-name".quote-identifiers.strategy]`


[.description]
--
Identifiers can be quoted using one of the available strategies.

Set to `none` by default, meaning no identifiers will be quoted. If set to `all`, all identifiers and column definitions will be quoted. Additionally, setting it to `all-except-column-definitions` will skip the column definitions, which can usually be required when they exist, or else use the option `only-keywords` to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUOTE_IDENTIFIERS_STRATEGY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`

|===
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down Expand Up @@ -861,10 +858,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down Expand Up @@ -306,6 +303,23 @@ endif::add-copy-button-to-env-var[]
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.metrics.enabled]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.metrics.enabled[quarkus.hibernate-orm.metrics.enabled]`


[.description]
--
Whether metrics are published if a metrics extension is enabled.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_METRICS_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_METRICS_ENABLED+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.active]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.active[quarkus.hibernate-orm.active]`


Expand Down Expand Up @@ -1055,10 +1069,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down Expand Up @@ -1071,10 +1068,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down
10 changes: 2 additions & 8 deletions _generated-doc/main/config/quarkus-hibernate-orm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down Expand Up @@ -1127,10 +1124,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUOTE_IDENTIFIERS_STRATEGY+++`
endif::add-copy-button-to-env-var[]
-- a|
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator.

Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], `all`, `all-except-column-definitions`, `only-keywords`
`none`, `all`, `all-except-column-definitions`, `only-keywords`
|`none`


Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/_attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
:jandex-version: 3.1.3
:jandex-gradle-plugin-version: 1.0.0
:kotlin-version: 1.9.10
:grpc-version: 1.56.1
:grpc-version: 1.57.2
:protoc-version: 3.22.0
:gcf-invoker-version: 1.3.0
:hibernate-orm-version: 6.2
Expand Down
10 changes: 5 additions & 5 deletions _versions/main/guides/rest-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -669,20 +669,20 @@ First, Wiremock needs to be added as a test dependency. For a Maven project that
.pom.xml
----
<dependency>
<groupId>com.github.tomakehurst</groupId>
<artifactId>wiremock-jre8</artifactId>
<groupId>org.wiremock</groupId>
<artifactId>wiremock</artifactId>
<scope>test</scope>
<version>${wiremock.version}</version> <1>
</dependency>
----
<1> Use a proper Wiremock version. All available versions can be found link:https://search.maven.org/artifact/com.github.tomakehurst/wiremock-jre8[here].
<1> Use a proper Wiremock version. All available versions can be found link:https://search.maven.org/artifact/org.wiremock/wiremock[here].

[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
.build.gradle
----
testImplementation("com.github.tomakehurst:wiremock-jre8:$wiremockVersion") <1>
testImplementation("org.wiremock:wiremock:$wiremockVersion") <1>
----
<1> Use a proper Wiremock version. All available versions can be found link:https://search.maven.org/artifact/com.github.tomakehurst/wiremock-jre8[here].
<1> Use a proper Wiremock version. All available versions can be found link:https://search.maven.org/artifact/org.wiremock/wiremock[here].

In Quarkus tests when some service needs to be started before the Quarkus tests are ran, we utilize the `@io.quarkus.test.common.QuarkusTestResource`
annotation to specify a `io.quarkus.test.common.QuarkusTestResourceLifecycleManager` which can start the service and supply configuration
Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/security-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ You can customize the following core security components of Quarkus:
* `IdentityProvider`
* `SecurityidentityAugmentor`

For more information about customizing Quarkus Security, including reactive security and how to register a security provider, see the Quarkus link:{url-quarkusio-guides}security-customization[Security tips and tricks] guide.
For more information about customizing Quarkus Security, including reactive security and how to register a security provider, see the Quarkus xref:security-customization.adoc[Security tips and tricks] guide.

== References

Expand Down
Loading

0 comments on commit bd37b16

Please sign in to comment.