Skip to content

Commit 8296b76

Browse files
committed
Sync web site with Quarkus documentation
1 parent c699036 commit 8296b76

File tree

8 files changed

+41
-52
lines changed

8 files changed

+41
-52
lines changed

_generated-doc/latest/infra/quarkus-all-build-items.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4426,7 +4426,7 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-sp
44264426
[.description]
44274427
--
44284428
This hold all files in the user's project root
4429-
-- a|`java.util.List<WorkspaceItem> workspaceItems`
4429+
-- a|`io.quarkus.devui.spi.workspace.WorkspaceItems workspaceItems`
44304430
44314431
_No Javadoc found_
44324432

_guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Common attributes.
22
// --> No blank lines (it ends the document header)
33
:project-name: Quarkus
4-
:quarkus-version: 3.28.3
4+
:quarkus-version: 3.28.4
55
:quarkus-platform-groupid: io.quarkus.platform
66
// .
77
:maven-version: 3.9.11

_guides/extension-writing-dev-service.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ For example,
118118

119119
[source,java]
120120
----
121-
@BuildStep(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class)
121+
@BuildStep(onlyIfNot = IsNormal.class, onlyIf = DevServicesConfig.Enabled.class)
122122
public DevServicesResultBuildItem createContainer(MyConfig config) {}
123123
----
124124

_guides/hibernate-orm.adoc

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ They will often map to Hibernate ORM configuration properties but could have dif
100100

101101
Also, Quarkus will set many Hibernate ORM configuration settings automatically, and will often use more modern defaults.
102102

103-
For a list of the items that you can set in `{config-file}`, see <<hibernate-configuration-properties,Hibernate ORM configuration properties>>.
103+
For a list of the items that you can set in `{config-file}`, see <<configuration-reference>>.
104104

105105
An `EntityManagerFactory` will be created based on the Quarkus `datasource` configuration as long as the Hibernate ORM extension is listed among your project dependencies.
106106

@@ -295,9 +295,7 @@ There are no required properties, as long as a default datasource is configured.
295295
When no property is set, Quarkus can typically infer everything it needs to set up Hibernate ORM
296296
and will have it use the default datasource.
297297

298-
The configuration properties listed here allow you to override such defaults, and customize and tune various aspects.
299-
300-
include::{generated-dir}/config/quarkus-hibernate-orm.adoc[opts=optional, leveloffset=+2]
298+
The configuration properties listed in <<configuration-reference>> allow you to override such defaults, and customize and tune various aspects.
301299

302300
[NOTE]
303301
====
@@ -314,20 +312,6 @@ quarkus.hibernate-orm.persistence-xml.ignore=true
314312
----
315313
====
316314

317-
[TIP]
318-
====
319-
Want to start a PostgreSQL server on the side with Docker?
320-
321-
[source,bash]
322-
----
323-
docker run --rm=true --name postgres-quarkus-hibernate -e POSTGRES_USER=hibernate \
324-
-e POSTGRES_PASSWORD=hibernate -e POSTGRES_DB=hibernate_db \
325-
-p 5432:5432 postgres:14.1
326-
----
327-
328-
This will start a non-durable empty database: ideal for a quick experiment!
329-
====
330-
331315
[[multiple-persistence-units]]
332316
=== Multiple persistence units
333317

@@ -908,7 +892,7 @@ quarkus.hibernate-orm."offline".dialect.mariadb.bytes-per-character=1
908892
quarkus.hibernate-orm."offline".dialect.mariadb.no-backslash-escapes=true
909893
----
910894

911-
Refer to the <<hibernate-configuration-properties,Hibernate ORM configuration properties>> section for more details on the available properties.
895+
Refer to the <<configuration-reference>> section for more details on the available properties.
912896

913897

914898
[[caching]]
@@ -1895,3 +1879,8 @@ to learn more about the `dataStore` attribute.
18951879
Please refer to the corresponding https://hibernate.org/repositories/[Hibernate Data Repositories]
18961880
and https://jakarta.ee/specifications/data/1.0/jakarta-data-1.0[Jakarta Data]
18971881
guides to learn what else they have to offer.
1882+
1883+
[[configuration-reference]]
1884+
== Configuration Reference for Hibernate ORM
1885+
1886+
include::{generated-dir}/config/quarkus-hibernate-orm.adoc[opts=optional, leveloffset=+2]

_guides/hibernate-reactive.adoc

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Blocking (non-reactive) and reactive configuration xref:orm-and-reactive-extensi
116116

117117
WARNING: Configuring Hibernate Reactive using the standard `persistence.xml` configuration file is not supported.
118118

119-
See section <<hr-configuration-properties,Hibernate Reactive configuration properties>> for the list of properties you can set in `{config-file}`.
119+
See section <<configuration-reference>> for the list of properties you can set in `{config-file}`.
120120

121121
A `Mutiny.SessionFactory` will be created based on the Quarkus `datasource` configuration as long as the Hibernate Reactive extension is listed among your project dependencies.
122122

@@ -193,24 +193,7 @@ and will have it use the default datasource.
193193

194194
The configuration properties listed here allow you to override such defaults, and customize and tune various aspects.
195195

196-
Hibernate Reactive uses the same properties you would use for Hibernate ORM. You will notice that some properties
197-
contain `jdbc` in the name but there is no JDBC in Hibernate Reactive, these are simply legacy property names.
198-
199-
include::{generated-dir}/config/quarkus-hibernate-orm.adoc[opts=optional, leveloffset=+2]
200-
201-
[TIP]
202-
====
203-
Want to start a PostgreSQL server on the side with Docker?
204-
205-
[source,bash]
206-
----
207-
docker run --rm --name postgres-quarkus-hibernate -e POSTGRES_USER=quarkus_test \
208-
-e POSTGRES_PASSWORD=quarkus_test -e POSTGRES_DB=quarkus_test \
209-
-p 5432:5432 postgres:14.1
210-
----
211-
212-
This will start a non-durable empty database: ideal for a quick experiment!
213-
====
196+
Hibernate Reactive uses the same properties you would use for Hibernate ORM: see <<configuration-reference>>.
214197

215198
[[orm-and-reactive-extension-simultaneously]]
216199
=== Hibernate ORM and Reactive extensions simultaneously
@@ -428,3 +411,16 @@ by providing active record style entities (and repositories) and focuses on maki
428411
To find out more on how the <<quarkus-hibernate-orm_quarkus-hibernate-orm-validation-mode,`quarkus.hibernate-orm.validation.mode` configuration property>>.
429412
influence your Hibernate Reactive application see the xref:hibernate-orm.adoc#validator_integration[corresponding Hibernate ORM guide],
430413
as these modes work the same in both cases.
414+
415+
[[configuration-reference]]
416+
== Configuration Reference for Hibernate Reactive
417+
418+
[TIP]
419+
====
420+
You will notice that some properties
421+
contain "jdbc" in their name: this is because Hibernate ORM refers to its "data access" layer as "JDBC" for historical reasons. Hibernate Reactive uses Vert.x Reactive SQL clients for its data access layer rather than JDBC.
422+
423+
Regardless of their name, these properties still make sense for Hibernate Reactive.
424+
====
425+
426+
include::{generated-dir}/config/quarkus-hibernate-orm.adoc[opts=optional, leveloffset=+2]

_guides/logging.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ Log file rotation ensures efficient log management by preserving a specified num
497497
+
498498
[source, properties]
499499
----
500-
quarkus.log.file.enable=true
500+
quarkus.log.file.enabled=true
501501
quarkus.log.file.path=application.log
502502
quarkus.log.file.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
503503
----
@@ -506,7 +506,7 @@ quarkus.log.file.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
506506
+
507507
[source, properties]
508508
----
509-
quarkus.log.handler.file.my-file-handler.enable=true
509+
quarkus.log.handler.file.my-file-handler.enabled=true
510510
quarkus.log.handler.file.my-file-handler.path=application.log
511511
quarkus.log.handler.file.my-file-handler.format=%d{yyyy-MM-dd HH:mm:ss} [com.example] %s%e%n
512512
@@ -529,7 +529,7 @@ When enabled, it sends all log events to a syslog server, typically the local sy
529529
+
530530
[source, properties]
531531
----
532-
quarkus.log.syslog.enable=true
532+
quarkus.log.syslog.enabled=true
533533
quarkus.log.syslog.app-name=my-application
534534
quarkus.log.syslog.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
535535
----
@@ -538,7 +538,7 @@ quarkus.log.syslog.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
538538
+
539539
[source, properties]
540540
----
541-
quarkus.log.handler.syslog.my-syslog-handler.enable=true
541+
quarkus.log.handler.syslog.my-syslog-handler.enabled=true
542542
quarkus.log.handler.syslog.my-syslog-handler.app-name=my-application
543543
quarkus.log.handler.syslog.my-syslog-handler.format=%d{yyyy-MM-dd HH:mm:ss} [com.example] %s%e%n
544544
@@ -559,7 +559,7 @@ When enabled, it sends all log events to a socket, such as a Logstash server.
559559
+
560560
[source, properties]
561561
----
562-
quarkus.log.socket.enable=true
562+
quarkus.log.socket.enabled=true
563563
quarkus.log.socket.endpoint=localhost:4560
564564
----
565565

@@ -641,7 +641,7 @@ For example, `-Dquarkus.log.category.\"io.quarkus\".level=DEBUG`.
641641
.File TRACE logging configuration
642642
[source, properties]
643643
----
644-
quarkus.log.file.enable=true
644+
quarkus.log.file.enabled=true
645645
# Send output to a trace.log file under the /tmp directory
646646
quarkus.log.file.path=/tmp/trace.log
647647
quarkus.log.file.level=TRACE
@@ -664,7 +664,7 @@ quarkus.log.console.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
664664
# Configure a named handler that logs to console
665665
quarkus.log.handler.console."STRUCTURED_LOGGING".format=%e%n
666666
# Configure a named handler that logs to file
667-
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".enable=true
667+
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".enabled=true
668668
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".format=%e%n
669669
# Configure the category and link the two named handlers to it
670670
quarkus.log.category."io.quarkus.category".level=INFO
@@ -676,7 +676,7 @@ quarkus.log.category."io.quarkus.category".handlers=STRUCTURED_LOGGING,STRUCTURE
676676
[source, properties]
677677
----
678678
# configure a named file handler that sends the output to 'quarkus.log'
679-
quarkus.log.handler.file.CONSOLE_MIRROR.enable=true
679+
quarkus.log.handler.file.CONSOLE_MIRROR.enabled=true
680680
quarkus.log.handler.file.CONSOLE_MIRROR.path=quarkus.log
681681
# attach the handler to the root logger
682682
quarkus.log.handlers=CONSOLE_MIRROR

_guides/rest-client.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ import jakarta.ws.rs.QueryParam;
157157
import jakarta.ws.rs.core.MultivaluedMap;
158158
import java.util.Map;
159159
import java.util.Set;
160-
import java util.Optional;
160+
import java.util.Optional;
161161
162162
@Path("/extensions")
163163
@RegisterRestClient(configKey = "extensions-api")
@@ -466,7 +466,7 @@ The name of the property needs to follow a certain convention which is best disp
466466
[source,properties]
467467
----
468468
# Your configuration properties
469-
quarkus.rest-client."org.acme.rest.client.ExtensionsService".url=https://stage.code.quarkus.io/api # // <1>
469+
quarkus.rest-client."org.acme.rest.client.ExtensionsService".url=https://stage.code.quarkus.io/api // <1>
470470
----
471471

472472
<1> Having this configuration means that all requests performed using `org.acme.rest.client.ExtensionsService` will use `https://stage.code.quarkus.io/api` as the base URL.
@@ -1334,7 +1334,7 @@ Alternatively, you can implement the `ResteasyReactiveClientRequestFilter` inter
13341334
public class TestClientRequestFilter implements ResteasyReactiveClientRequestFilter {
13351335
13361336
@Override
1337-
public void filter(ResteasyReactiveClientRequestFilter requestContext) {
1337+
public void filter(ResteasyReactiveClientRequestContext requestContext) {
13381338
Providers providers = requestContext.getProviders();
13391339
// ...
13401340
}

_guides/security-oidc-expanded-configuration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1312,6 +1312,10 @@ According to the https://datatracker.ietf.org/doc/rfc9728/[OAuth2 Protected Reso
13121312

13131313
If it is configured as a relative path then it is added to the current request URL's host and port to build a resource identifier URL. If it is not configured at all then, unless it is a default tenant id, the tenand id is added to the current request URL's host and port to build a resource identifier URL.
13141314

1315+
By default, when no `quarkus.oidc.resource-metadata.resource` is configured, a protected resource metadata route is available at a `/.well-known/oauth-protected-resource` relative address.
1316+
1317+
Setting `quarkus.oidc.resource-metadata.resource` to a relative value impacts the protected resource metadata route's address. For example, setting `quarkus.oidc.resource-metadata.resource=resource` for a default OIDC tenant makes its protected resource metadata route available at `/.well-known/oauth-protected-resource/resource`.
1318+
13151319
The resource identifier URL scheme is set to `HTTPS` by default. You can enable an `HTTP` URL scheme with `quarkus.oidc.resource-metadata.force-https-scheme=false`, it can be particularly useful in simple demos and tests.
13161320

13171321
`quarkus.oidc.resource-metadata.authorization-server` allows to customize an authorization server URL that will be included in the resource metadata. The `quarkus.oidc.auth-server-url` URL is included by default, however, for some cases where an OIDC proxy interposes over the actual OIDC provider, returning the OIDC proxy's URL is required instead.

0 commit comments

Comments
 (0)