You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
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."
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."
218
218
categories: contributing
219
219
id: doc-contribute-howto
220
220
type: howto
@@ -243,7 +243,7 @@ types:
243
243
- title: Configure data sources in Quarkus
244
244
filename: datasource.adoc
245
245
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"
247
247
id: datasources
248
248
type: tutorial
249
249
url: /guides/datasource
@@ -276,7 +276,7 @@ types:
276
276
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
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).
- title: Simplified Hibernate ORM with Panache and Kotlin
962
962
filename: hibernate-orm-panache-kotlin.adoc
963
963
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"
965
965
type: guide
966
966
url: /guides/hibernate-orm-panache-kotlin
967
967
- title: Simplified Hibernate Reactive with Panache
@@ -979,13 +979,13 @@ types:
979
979
- title: Simplified MongoDB with Panache and Kotlin
980
980
filename: mongodb-panache-kotlin.adoc
981
981
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"
983
983
type: guide
984
984
url: /guides/mongodb-panache-kotlin
985
985
- title: SmallRye Fault Tolerance
986
986
filename: smallrye-fault-tolerance.adoc
987
987
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"
989
989
type: guide
990
990
url: /guides/smallrye-fault-tolerance
991
991
- title: SmallRye GraphQL
@@ -1158,7 +1158,7 @@ types:
1158
1158
- title: Using SSL With Native Executables
1159
1159
filename: native-and-ssl.adoc
1160
1160
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"
1162
1162
type: guide
1163
1163
url: /guides/native-and-ssl
1164
1164
- title: Using Security with .properties File
@@ -1265,7 +1265,7 @@ types:
1265
1265
- title: Validation with Hibernate Validator
1266
1266
filename: validation.adoc
1267
1267
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
Copy file name to clipboardExpand all lines: _versions/main/guides/doc-contribute-docs-howto.adoc
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,21 +8,23 @@ include::_attributes.adoc[]
8
8
:categories: contributing
9
9
:fn-diataxis: footnote:diataxis[Procida, D. Diátaxis documentation framework. https://diataxis.fr/]
10
10
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.
14
12
15
13
Quarkus docs use link:https://asciidoc.org/[AsciiDoc] markup.
16
14
17
-
We suggest you have the following materials nearby:
15
+
== Prerequisites
18
16
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.
22
23
23
24
== Locate the source files for Quarkus docs
24
25
25
26
- 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].
26
28
- Configuration documentation is generated from JavaDoc comments in Java source files.
27
29
- Java, YAML, and other source files can also be xref:doc-reference.adoc#reference-source-code[referenced] by AsciiDoc files.
28
30
- 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.
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.
211
213
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].
0 commit comments