minor corrections/improvements
diff --git a/src/site/antora/modules/ROOT/pages/5min.adoc b/src/site/antora/modules/ROOT/pages/5min.adoc
index 967aa09..b1ba814 100644
--- a/src/site/antora/modules/ROOT/pages/5min.adoc
+++ b/src/site/antora/modules/ROOT/pages/5min.adoc
@@ -17,8 +17,9 @@
= Learn Log4j in 5 minutes!
-You need a crash course on Log4j?
-You are at the right place!
+Do you need a crash course on Log4j?
+You have come to the right place!
+If you are looking for a more detailed read, please see {logging-services-url}/what-is-logging.html[What is logging?].
[#what]
== What is logging and Log4j?
@@ -33,16 +34,16 @@
}
----
-This provides observability into an application's runtime. (See {logging-services-url}/what-is-logging.html[What is logging?] page for a longer read.)
+This provides observability into an application's runtime.
But we can do way better than a `printf()` statement!
* Enhance the message with additional information (timestamp, class & method name, line number, host, severity, etc.)
-* Write the message in a different way, using a different **layout** (CSV, JSON, etc.)
+* Write the message differently, using a different **layout** (CSV, JSON, etc.)
* Write the message to a different medium, using a different **appender** (file, socket, database, queue, etc.)
* Write only some of the messages, using a **filter** (e.g. filter by severity, content, etc.)
-Log4j is versatile, industrial-grade Java logging framework delivering all these and more in one product.
+Log4j is a versatile, industrial-grade Java logging framework delivering all these and more in one product.
It is essentially composed of a **logging API** and its **implementation**:
Log4j API::
@@ -50,11 +51,11 @@
This needs to be available at compile-time and no configuration is needed.
Log4j Core::
-The logging implementation which is responsible for filtering, routing, encoding, and appending log events.
+The logging implementation is responsible for filtering, routing, encoding, and appending log events.
This needs to be available at runtime and configured by the user.
[#logging]
-== How do I log using Log4j?
+== How do I write logs using Log4j?
Add the `log4j-api` dependency to your application:
@@ -170,7 +171,7 @@
==== Pass exception as the last extra argument
* [ ] Don't call `Throwable#printStackTrace()`!
-This not only circumvents the logging, but can also leak sensitive information!
+This not only circumvents the logging but can also leak sensitive information!
+
[source,java]
----
@@ -187,7 +188,7 @@
----
* [ ] Don't provide both `Throwable#getMessage()` and `Throwable` itself!
-This bloats the log message with duplicate exception message.
+This bloats the log message with a duplicate exception message.
+
[source,java]
----
@@ -210,7 +211,7 @@
* [ ] Don't use `String` concatenation to format arguments!
This circumvents the handling of arguments by message type and layout.
More importantly, **this approach is prone to attacks!**
-Imagine `userId` being provided by user with the following content:
+Imagine `userId` being provided by the user with the following content:
`placeholders for non-existing args to trigger failure: {} {} \{dangerousLookup}`
+
[source,java]
@@ -330,11 +331,11 @@
</Configuration>
----
-<1> xref:manual/appenders.adoc[Appenders] are responsible for writing log events to console, file, socket, database, etc.
+<1> xref:manual/appenders.adoc[Appenders] are responsible for writing log events to the console, file, socket, database, etc.
<2> xref:manual/appenders.adoc#ConsoleAppender[Console Appender] is used to write logs to the console.
<3> xref:manual/json-template-layout.adoc[JSON Template Layout] is used to encode log events in JSON.
-<4> Log events generated by classes in the `com.mycompany` package (incl. its subpackages) and that are of level `INFO` and higher (i.e., `WARN`, `ERROR`, `FATAL`) will be consumed.
-<5> Unless specified otherwise, log events of level `WARN` and and higher will be consumed.
+<4> Log events generated by classes in the `com.mycompany` package (incl. its sub packages) and that are of level `INFO` and higher (i.e., `WARN`, `ERROR`, `FATAL`) will be consumed.
+<5> Unless specified otherwise, log events of level `WARN` and higher will be consumed.
<6> Unless specified otherwise, log events will be forwarded to the `console` appender defined earlier.
You are strongly advised to use a different Log4j configuration for tests.
@@ -471,5 +472,5 @@
Support::
Confused?
-Having problem while setting up Log4j?
+Having a problem while setting up Log4j?
See the {logging-services-url}/support.html[Support] page.
