vy commented on code in PR #2487: URL: https://github.com/apache/logging-log4j2/pull/2487#discussion_r1573883787
########## src/site/antora/modules/ROOT/pages/index.adoc: ########## @@ -19,15 +19,38 @@ Apache Log4j is a versatile, industrial-grade Java logging framework composed of an API, its implementation, and components to assist the deployment for various use cases. Log4j is https://security.googleblog.com/2021/12/apache-log4j-vulnerability.html[used by 8% of the Maven ecosystem] and listed as one of https://docs.google.com/spreadsheets/d/1ONZ4qeMq8xmeCHX03lIgIYE4MEXVfVL6oj05lbuXTDM/edit#gid=1024997528[the top 100 critical open source software projects]. -The project is actively maintained by a link:/team-list.html[team] of several volunteers and xref:support.adoc[support]ed by a big community. +The project is actively maintained by a {logging-services-url}/team-list.html[team] of several volunteers and {logging-services-url}/support[support]ed by a big community. [#shortcuts] == Shortcuts -- xref:download.adoc#using-a-build-system[How can I add Log4j artifacts to my Maven/Ivy/Gradle project?] +- xref:manual/installation.adoc[How can I add Log4j artifacts to my Maven/Ivy/Gradle project?] - xref:manual/usage.adoc[How can I use the Log4j API?] - xref:manual/configuration.adoc[How can I configure my `log4j2.xml`?] - xref:release-notes.adoc[Where are the release notes?] -- xref:support.adoc[**I need help!**] +- {logging-services-url}/support[**I need help!**] + +[#simple-to-use] +== Simple to use + +Apache Log4j is easy to use. The example below shows you how to create a Logger instance, that +you can use to log messages to the console. As soon as you can understand this little bit of code, you can start using +Log4j in your applications. + +[source,java] +---- +import java.util.logging.LogManager; +import java.util.logging.Logger; + +class Application { + private static final Logger LOGGER = LogManager.getLogger(); <1> + + public void action() { + LOGGER.info("Hello, World!"); <2> + } +} +---- +<1> Get a Logger instance +<2> Log a message on info level Review Comment: This work is partial and still in progress by @grobmeier in `main`. ```suggestion ``` ########## src/site/antora/modules/ROOT/pages/index.adoc: ########## @@ -60,3 +83,26 @@ Extensibility:: Log4j contains a fully-fledged xref:manual/plugins.adoc[plugin support] that users can leverage to extend its functionality. You can easily add your own components (layouts, appenders, filters, etc.) or customizing existing ones (e.g., adding new directives to the xref:manual/layouts.adoc#PatternLayout[Pattern] or xref:manual/json-template-layout.adoc#extending[JSON Template Layout]). Check out the xref:manual/extending.adoc[Extending Log4j] page. + +[#requirements] +== Requirements + +Log4j 2 runtime requires a minimum of Java 8. +Older versions of Java are supported by previous releases. + +[#older-releases] +== Older releases + +Are looking for old versions of Log4j? While we recommend to always use the latest versions, you can find the older +versions here: Review Comment: ```suggestion Are you looking for old versions of Log4j? While we recommend to always use the latest version, you can find the older versions here: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
