Skip to content

Commit

Permalink
Sync web site with Quarkus documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
quarkusbot committed Sep 11, 2024
1 parent f34469c commit f75ff2f
Show file tree
Hide file tree
Showing 38 changed files with 2,115 additions and 280 deletions.
13 changes: 13 additions & 0 deletions _data/versioned/latest/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,7 @@ types:
- title: TLS registry reference
filename: tls-registry-reference.adoc
summary: TLS registry configuration and usage
categories: web
topics:
- TLS
- http
Expand All @@ -335,6 +336,7 @@ types:
- network
extensions:
- io.quarkus:quarkus-tls-registry
id: tls-registry-reference
type: reference
url: /guides/tls-registry-reference
- title: Using OpenTelemetry
Expand Down Expand Up @@ -1634,6 +1636,17 @@ types:
- io.quarkus:quarkus-funqy-knative-events
type: guide
url: /guides/funqy-knative-events
- title: Generating CycloneDX BOMs
filename: cyclonedx.adoc
summary: This guide explains how to generate SBOMs for Quarkus applications in the CycloneDX format.
categories: tooling
topics:
- sbom
extensions:
- io.quarkus:quarkus-cyclonedx
id: cyclonedx
type: guide
url: /guides/cyclonedx
- title: Generating Jakarta REST resources with Panache
filename: rest-data-panache.adoc
summary: Hibernate ORM REST Data with Panache simplifies the creation of CRUD applications based on Jakarta REST and Hibernate ORM.
Expand Down
513 changes: 503 additions & 10 deletions _generated-doc/latest/config/quarkus-all-config.adoc

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-incubati

[.description]
--
A temporary option introduced to avoid a logging warning when ``-Dquarkus.bootstrap.incubating-model-resolver++}++ is added to the build command line. This option enables an incubating implementation of the Quarkus Application Model resolver. This option will be removed as soon as the incubating implementation becomes the default one.
A temporary option introduced to avoid a logging warning when `-Dquarkus.bootstrap.incubating-model-resolver` is added to the build command line. This option enables an incubating implementation of the Quarkus Application Model resolver. This option will be removed as soon as the incubating implementation becomes the default one.


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CLASS_LOADING_REMOVED_RESOURCES__GROUP_ID_ARTIFACT_ID_+++`
endif::add-copy-button-to-env-var[]
--
|list of Map<String,Set<String>>
|Map<String,Set<String>>
|

|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-report-erro

[.description]
--
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident.
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident. Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project.


ifdef::add-copy-button-to-env-var[]
Expand Down
82 changes: 82 additions & 0 deletions _generated-doc/latest/config/quarkus-cyclonedx.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
:summaryTableId: quarkus-cyclonedx_quarkus-cyclonedx
[.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.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-skip]] [.property-path]##`quarkus.cyclonedx.skip`##

[.description]
--
Whether to skip SBOM generation


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

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-format]] [.property-path]##`quarkus.cyclonedx.format`##

[.description]
--
SBOM file format. Supported formats are ++{++code json++}++ and ++{++code xml++}++. The default format is JSON. If both are desired then `all` could be used as the value of this option.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_FORMAT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CYCLONEDX_FORMAT+++`
endif::add-copy-button-to-env-var[]
--
|string
|`json`

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-schema-version]] [.property-path]##`quarkus.cyclonedx.schema-version`##

[.description]
--
CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-include-license-text]] [.property-path]##`quarkus.cyclonedx.include-license-text`##

[.description]
--
Whether to include the license text into generated SBOMs.


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

|===


:!summaryTableId:
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
:summaryTableId: quarkus-cyclonedx_quarkus-cyclonedx
[.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.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-skip]] [.property-path]##`quarkus.cyclonedx.skip`##

[.description]
--
Whether to skip SBOM generation


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

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-format]] [.property-path]##`quarkus.cyclonedx.format`##

[.description]
--
SBOM file format. Supported formats are ++{++code json++}++ and ++{++code xml++}++. The default format is JSON. If both are desired then `all` could be used as the value of this option.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_FORMAT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CYCLONEDX_FORMAT+++`
endif::add-copy-button-to-env-var[]
--
|string
|`json`

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-schema-version]] [.property-path]##`quarkus.cyclonedx.schema-version`##

[.description]
--
CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-include-license-text]] [.property-path]##`quarkus.cyclonedx.include-license-text`##

[.description]
--
Whether to include the license text into generated SBOMs.


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

|===


:!summaryTableId:
Loading

0 comments on commit f75ff2f

Please sign in to comment.