From f9c52c0668ad1ca6c682cd1ec6e23514225212a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Mal=C3=A9=C5=99?= Date: Thu, 2 Nov 2023 14:20:02 +0100 Subject: [PATCH] Tiny Vale tweaks for Datasource and Logging guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Maléř --- docs/src/main/asciidoc/datasource.adoc | 10 +++++----- docs/src/main/asciidoc/logging.adoc | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/src/main/asciidoc/datasource.adoc b/docs/src/main/asciidoc/datasource.adoc index 164b9e16dff91..997bed9640716 100644 --- a/docs/src/main/asciidoc/datasource.adoc +++ b/docs/src/main/asciidoc/datasource.adoc @@ -15,7 +15,7 @@ Use a unified configuration model to define data sources for Java Database Conne //// Note for contributors and writers: -In text, use `data source` in code, `datasource` or `DataSource` is more common. +In text, use "data source". In code, "datasource" or "DataSource" is more common. See, https://docs.oracle.com/javase/tutorial/jdbc/basics/connecting.html //// @@ -32,7 +32,7 @@ Additionally, refer to the Quarkus xref:hibernate-orm.adoc[Hibernate ORM] guide == Get started with configuring `datasources` in Quarkus -For rapid configuration of datasources, this section offers a brief overview and code samples for testing and utilization, suitable for users familiar with the fundamentals. +For users familiar with the fundamentals, this section provides an overview and code samples to set up data sources quickly. For more advanced configuration with examples, see <>. @@ -48,7 +48,7 @@ In dev mode, if you do not provide any explicit database connection details, Qua If you provide user credentials, the underlying database will be configured to use them. This is useful if you want to connect to the database with an external tool. -To utilize this feature, ensure a Docker or Podman container runtime is installed, depending on the database type. Certain databases, such as H2, operate in in-memory mode and do not require a container runtime. +To use this feature, ensure a Docker or Podman container runtime is installed, depending on the database type. Certain databases, such as H2, operate in in-memory mode and do not require a container runtime. TIP: Prefix the actual connection details for prod mode with `%prod.` to ensure they are not applied in dev mode. For more information, see the xref:config-reference.adoc#profiles[Profiles] section of the "Configuration reference" guide. @@ -160,7 +160,7 @@ Quarkus currently includes the following built-in database kinds: You can use any JDBC driver in a Quarkus app in JVM mode as described in <>. However, using a non-built-in database kind is unlikely to work when compiling your application to a native executable. -For native executable builds, it is recommended to either utilize the available JDBC Quarkus extensions or contribute a custom extension for your specific driver. +For native executable builds, it is recommended to either use the available JDBC Quarkus extensions or contribute a custom extension for your specific driver. ==== . Configure the following properties to define credentials: @@ -216,7 +216,7 @@ However, for custom drivers, Agroal needs to be added explicitly. ==== -.. For use with a custom JDBC driver, add the `quarkus-agroal` dependency to your project alongside the extension for your relational database driver: +.. For use with a custom JDBC driver, add the `quarkus-agroal` dependency to your project alongside the extension for your relational database driver: + [source,bash] ---- diff --git a/docs/src/main/asciidoc/logging.adoc b/docs/src/main/asciidoc/logging.adoc index 7bc595abbcd02..c22add0efb800 100644 --- a/docs/src/main/asciidoc/logging.adoc +++ b/docs/src/main/asciidoc/logging.adoc @@ -14,7 +14,7 @@ include::_attributes.adoc[] Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs. Quarkus uses the JBoss Log Manager logging backend for publishing application and framework logs. -Quarkus supports the JBoss Logging API as well as multiple other logging APIs, seamlessly integrated with JBoss Log Manager. +Quarkus supports the JBoss Logging API and multiple other logging APIs, seamlessly integrated with JBoss Log Manager. You can use any of the <>: * link:https://github.com/jboss-logging/jboss-logging[JBoss Logging] @@ -334,7 +334,7 @@ The logging format string supports the following symbols: |%e|Exception|Renders the thrown exception, if any. |%F|Source file|Renders the source file name.footnote:calc[] |%h|Host name|Renders the system simple host name. -|%H|Qualified host name|Renders the system's fully qualified host name, which may be the same as the simple host name, depending on OS configuration. +|%H|Qualified host name|Renders the system's fully qualified host name, which may be the same as the simple host name, depending on operating system configuration. |%i|Process ID|Render the current process PID. |%l|Source location|Renders the source location information, which includes source file name, line number, class name, and method name.footnote:calc[] |%L|Source line|Renders the source line number.footnote:calc[] @@ -474,7 +474,7 @@ For details about its configuration, see the xref:#quarkus-log-logging-log-confi === Syslog log handler -The syslog handler in Quarkus follows the link:https://en.wikipedia.org/wiki/Syslog[Syslog] protocol, which is used to send log messages on Unix-like systems. +The syslog handler in Quarkus follows the link:https://en.wikipedia.org/wiki/Syslog[Syslog] protocol, which is used to send log messages on UNIX-like systems. It utilizes the protocol defined in link:https://tools.ietf.org/html/rfc5424[RFC 5424]. By default, the syslog handler is disabled. @@ -813,7 +813,7 @@ You get messages containing the MDC data: [source, text] ---- -08:48:13 INFO request.id=c37a3a36-b7f6-4492-83a1-de41dbc26fe2 request.path=/hello/test [me.sa.GreetingResourceJbossLogging] (executor-thread-1) request received +08:48:13 INFO request.id=c37a3a36-b7f6-4492-83a1-de41dbc26fe2 request.path=/hello/test [me.sa.GreetingResourceJbossLogging] (executor-thread-1) request received ---- ==== MDC and supported logging APIs