Skip to content

Commit 79fda55

Browse files
committed
Sync documentation of main branch
1 parent 393de61 commit 79fda55

File tree

5 files changed

+803
-593
lines changed

5 files changed

+803
-593
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ types:
55
- title: Authorization of web endpoints
66
filename: security-authorize-web-endpoints-reference.adoc
77
summary: Quarkus has an integrated pluggable web security layer.
8-
categories: "security, web"
8+
categories: "web, security"
99
id: security-authorize-web-endpoints-reference
1010
type: reference
1111
url: /guides/security-authorize-web-endpoints-reference
@@ -78,7 +78,7 @@ types:
7878
url: /guides/security-oidc-configuration-properties-reference
7979
- title: Quarkus style and content guidelines
8080
filename: doc-reference.adoc
81-
summary: Guidelines are provided to help you to contribute clear and consistent content that is also sourced in the required structure and composition of Quarkus documentation.
81+
summary: Guidelines are provided to help you to contribute clear and consistent content that is also sourced in the required diataxis structure and composition of Quarkus documentation.
8282
categories: contributing
8383
id: doc-reference
8484
type: reference
@@ -131,14 +131,14 @@ types:
131131
- title: Authentication mechanisms in Quarkus
132132
filename: security-authentication-mechanisms-concept.adoc
133133
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
134-
categories: "security, web"
134+
categories: "web, security"
135135
id: security-authentication-mechanisms-concept
136136
type: concepts
137137
url: /guides/security-authentication-mechanisms-concept
138138
- title: Basic authentication
139139
filename: security-basic-authentication-concept.adoc
140140
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
141-
categories: "security, web"
141+
categories: "web, security"
142142
id: security-basic-authentication-concept
143143
type: concepts
144144
url: /guides/security-basic-authentication-concept
@@ -152,21 +152,21 @@ types:
152152
- title: OpenID Connect (OIDC) Bearer authentication
153153
filename: security-oidc-bearer-token-authentication-concept.adoc
154154
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer authentication by using the Quarkus OpenID Connect (OIDC) extension.
155-
categories: "security, web"
155+
categories: "web, security"
156156
id: security-oidc-bearer-token-authentication-concept
157157
type: concepts
158158
url: /guides/security-oidc-bearer-token-authentication-concept
159159
- title: OpenID Connect authorization code flow mechanism for protecting web applications
160160
filename: security-oidc-code-flow-authentication-concept.adoc
161-
summary: "To protect your web applications, you can use the authorization code flow mechanism provided by the Quarkus OpenID Connect (OIDC) extension."
162-
categories: "security, web"
161+
summary: "To protect your web applications, you can use the industry-standard authorization code flow mechanism provided by the Quarkus OpenID Connect (OIDC) extension."
162+
categories: "web, security"
163163
id: security-oidc-code-flow-authentication-concept
164164
type: concepts
165165
url: /guides/security-oidc-code-flow-authentication-concept
166166
- title: Proactive authentication
167167
filename: security-proactive-authentication-concept.adoc
168168
summary: Proactive authentication is enabled in Quarkus by default.
169-
categories: "security, web"
169+
categories: "web, security"
170170
id: security-proactive-authentication-concept
171171
type: concepts
172172
url: /guides/security-proactive-authentication-concept
@@ -201,7 +201,7 @@ types:
201201
- title: Security vulnerability detection and reporting in Quarkus
202202
filename: security-vulnerability-detection-concept.adoc
203203
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
204-
categories: "security, contributing"
204+
categories: "contributing, security"
205205
id: security-vulnerability-detection-concept
206206
type: concepts
207207
url: /guides/security-vulnerability-detection-concept
@@ -214,7 +214,7 @@ types:
214214
howto:
215215
- title: Contribute to Quarkus documentation
216216
filename: doc-contribute-docs-howto.adoc
217-
summary: "Contribute to the documentation by using the recommended steps, workflow, and style guidance to ensure the content successfully renders on the Quarkus website portal."
217+
summary: "Contribute to the documentation by using the recommended diataxis content types, steps, workflow, and style guidance to ensure the content successfully renders on the Quarkus website portal."
218218
categories: contributing
219219
id: doc-contribute-howto
220220
type: howto
@@ -243,7 +243,7 @@ types:
243243
- title: Configure data sources in Quarkus
244244
filename: datasource.adoc
245245
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
246-
categories: "getting-started, reactive, data"
246+
categories: "getting-started, data"
247247
id: datasources
248248
type: tutorial
249249
url: /guides/datasource
@@ -276,7 +276,7 @@ types:
276276
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
277277
filename: security-oidc-code-flow-authentication-tutorial.adoc
278278
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
279-
categories: "security, web"
279+
categories: "web, security"
280280
id: security-oidc-code-flow-authentication-tutorial
281281
type: tutorial
282282
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -289,7 +289,7 @@ types:
289289
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
290290
filename: security-basic-authentication-tutorial.adoc
291291
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).
292-
categories: "security, getting-started"
292+
categories: "getting-started, security"
293293
id: security-basic-authentication-tutorial
294294
type: tutorial
295295
url: /guides/security-basic-authentication-tutorial
@@ -961,7 +961,7 @@ types:
961961
- title: Simplified Hibernate ORM with Panache and Kotlin
962962
filename: hibernate-orm-panache-kotlin.adoc
963963
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
964-
categories: "alt-languages, data"
964+
categories: "data, alt-languages"
965965
type: guide
966966
url: /guides/hibernate-orm-panache-kotlin
967967
- title: Simplified Hibernate Reactive with Panache
@@ -979,13 +979,13 @@ types:
979979
- title: Simplified MongoDB with Panache and Kotlin
980980
filename: mongodb-panache-kotlin.adoc
981981
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
982-
categories: "alt-languages, data"
982+
categories: "data, alt-languages"
983983
type: guide
984984
url: /guides/mongodb-panache-kotlin
985985
- title: SmallRye Fault Tolerance
986986
filename: smallrye-fault-tolerance.adoc
987987
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
988-
categories: "observability, web"
988+
categories: "web, observability"
989989
type: guide
990990
url: /guides/smallrye-fault-tolerance
991991
- title: SmallRye GraphQL
@@ -1158,7 +1158,7 @@ types:
11581158
- title: Using SSL With Native Executables
11591159
filename: native-and-ssl.adoc
11601160
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."
1161-
categories: "security, core, native"
1161+
categories: "core, security, native"
11621162
type: guide
11631163
url: /guides/native-and-ssl
11641164
- title: Using Security with .properties File
@@ -1265,7 +1265,7 @@ types:
12651265
- title: Validation with Hibernate Validator
12661266
filename: validation.adoc
12671267
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1268-
categories: "data, web"
1268+
categories: "web, data"
12691269
type: guide
12701270
url: /guides/validation
12711271
- title: Writing JSON REST Services
@@ -1334,8 +1334,6 @@ categories:
13341334
cat-id: native
13351335
- category: Observability
13361336
cat-id: observability
1337-
- category: Reactive
1338-
cat-id: reactive
13391337
- category: Security
13401338
cat-id: security
13411339
- category: Serialization

_versions/main/guides/config-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ APIs are not configuration aware and do not support the features described in th
265265
[[profiles]]
266266
== Profiles
267267

268-
We often need to configure differently our application depending on the target _environment_. For example, the local
268+
We often need to configure our application differently depending on the target _environment_. For example, the local
269269
development environment may be different from the production environment.
270270

271271
Configuration Profiles allow for multiple configurations in the same file or separate files and select between them via

_versions/main/guides/doc-contribute-docs-howto.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,23 @@ include::_attributes.adoc[]
88
:categories: contributing
99
:fn-diataxis: footnote:diataxis[Procida, D. Diátaxis documentation framework. https://diataxis.fr/]
1010

11-
Contribute to the documentation by using the recommended steps, workflow, and style guidance to ensure the content successfully renders on the Quarkus website portal.
12-
13-
== Prerequisites
11+
Contribute to the documentation by using the recommended diataxis content types, steps, workflow, and style guidance to ensure the content successfully renders on the Quarkus website portal.
1412

1513
Quarkus docs use link:https://asciidoc.org/[AsciiDoc] markup.
1614

17-
We suggest you have the following materials nearby:
15+
== Prerequisites
1816

19-
- An editor or IDE that provides syntax highlighting and previews for AsciiDoc, either natively or with a plugin.
20-
- The https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[AsciiDoc syntax reference]
21-
- The xref:{doc-guides}/doc-reference.adoc[Quarkus style and content guidelines] for the required syntax, preferred style, and other conventions.
17+
* You have an editor or IDE that provides syntax highlighting and previews for AsciiDoc, either natively or with a plugin.
18+
* You have reviewed the following Quarkus contributor resources:
19+
** The link:https://github.com/quarkusio/quarkus/blob/main/CONTRIBUTING.md#documentation[Documentation] section of the Quarkus "Contributing" guide.
20+
** The xref:{doc-guides}/doc-reference.adoc[Quarkus style and content guidelines] for the required syntax, preferred style, and other conventions.
21+
** The xref:{doc-guides}/doc-concept.adoc[Quarkus documentation content types].
22+
* You have the https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[AsciiDoc syntax reference] nearby.
2223

2324
== Locate the source files for Quarkus docs
2425

2526
- AsciiDoc files are in the `src/main/asciidoc` directory within the `docs` module of the {quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
27+
- The Quarkus doc templates are located in the `src/main/asciidoc/_templates` directory within the `docs` module of the {quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
2628
- Configuration documentation is generated from JavaDoc comments in Java source files.
2729
- Java, YAML, and other source files can also be xref:doc-reference.adoc#reference-source-code[referenced] by AsciiDoc files.
2830
- The link:https://quarkus.io/guides/[Quarkus documentation] menu page, also known as the doc index page, is sourced in the link:https://github.com/quarkusio/quarkusio.github.io[quarkusio.github.io] repository.
@@ -209,7 +211,7 @@ xref:<other-file-name>.adoc#title-heading[Title heading]
209211

210212
Breaking this example apart, we are using the `xref` macro to refer to another file (`xref:<name-of-the-file>.adoc[Human-readable label]`) and inserting the anchor ID for the target section (`#title-heading`) just after the file name.
211213

212-
See the xref:doc-reference.adoc#cross-references[Cross-references] section for path attributes that should be used in cross-document references.
214+
For more guidelines on writing cross-references, including the recommended path attributes, see xref:doc-reference.adoc#cross-references[Cross-references].
213215

214216
== Preview and build Quarkus documentation
215217

0 commit comments

Comments
 (0)