Re: Staging site

2024-08-10 Thread Gary Gregory
On the front page:
"Batteries included"
Err... what? Let's not get cute here please.

Gary

On Fri, Aug 9, 2024 at 3:02 AM Piotr P. Karwasz  wrote:
>
> Hi all,
>
> We finished revamping the documentation of Log4j 2. The result is
> available on the staging site:
>
> https://logging.staged.apache.org/log4j/2.x/
>
> The new version should be:
>
> * visually more appealing.
> * takes advantage of AsciiDoc admonition blocks and tabbed code blocks
> to help users find information more easily.
> * provides SEO friendly backward compatibility, e.g. for the Maven
> module specific pages that were removed, like log4j-flume-ng.html[1].
> * provides configuration examples in all four supported formats (ouf).
> * shortens code/configuration file examples by only showing the
> interesting part and pointing the user to a full example in the repo.
> * has pointers to the plugin reference from each Log4j plugin
> description. The plugin reference shows all config options, even if we
> forget to document them.
>
> Since I am working to release 2.24.0 soon, could you peruse the staging site?
> Please check the documentation of your favorite plugins. Also note
> some separate guides that might need your proof-reading:
>
> * Migrating from Log4j 1[2],
> * Migrating from Log4j 2[3],
> * Using Log4j with Jakarta EE[4]. It contains the content of
> `log4j-web`, `log4j-appserver`, log separation and others.
> * Using Log4j with cloud technologies[5],
> * Performance and its sub-pages[6]. Note that the performance figures
> were removed since we can not reproduce them.
>
> Piotr
>
> PS: The Log4j 3 site is not 100% ready yet, but we are working on it.
>
> [1] https://logging.staged.apache.org/log4j/2.x/log4j-flume-ng.html
> [2] https://logging.staged.apache.org/log4j/2.x/migrate-from-log4j1.html
> [3] https://logging.staged.apache.org/log4j/3.x/manual/migration.html
> [4] https://logging.staged.apache.org/log4j/2.x/jakarta.html
> [5] https://logging.staged.apache.org/log4j/2.x/soa.html
> [6] https://logging.staged.apache.org/log4j/2.x/manual/performance.html


Re: Staging site

2024-08-10 Thread Gary Gregory
Hi,

Does the tech we use to build/host allow for the inclusion of a search
box, say at the top? Javadoc now includes a search box which is quite
a nice feature IMO.

Gary

On Fri, Aug 9, 2024 at 3:02 AM Piotr P. Karwasz  wrote:
>
> Hi all,
>
> We finished revamping the documentation of Log4j 2. The result is
> available on the staging site:
>
> https://logging.staged.apache.org/log4j/2.x/
>
> The new version should be:
>
> * visually more appealing.
> * takes advantage of AsciiDoc admonition blocks and tabbed code blocks
> to help users find information more easily.
> * provides SEO friendly backward compatibility, e.g. for the Maven
> module specific pages that were removed, like log4j-flume-ng.html[1].
> * provides configuration examples in all four supported formats (ouf).
> * shortens code/configuration file examples by only showing the
> interesting part and pointing the user to a full example in the repo.
> * has pointers to the plugin reference from each Log4j plugin
> description. The plugin reference shows all config options, even if we
> forget to document them.
>
> Since I am working to release 2.24.0 soon, could you peruse the staging site?
> Please check the documentation of your favorite plugins. Also note
> some separate guides that might need your proof-reading:
>
> * Migrating from Log4j 1[2],
> * Migrating from Log4j 2[3],
> * Using Log4j with Jakarta EE[4]. It contains the content of
> `log4j-web`, `log4j-appserver`, log separation and others.
> * Using Log4j with cloud technologies[5],
> * Performance and its sub-pages[6]. Note that the performance figures
> were removed since we can not reproduce them.
>
> Piotr
>
> PS: The Log4j 3 site is not 100% ready yet, but we are working on it.
>
> [1] https://logging.staged.apache.org/log4j/2.x/log4j-flume-ng.html
> [2] https://logging.staged.apache.org/log4j/2.x/migrate-from-log4j1.html
> [3] https://logging.staged.apache.org/log4j/3.x/manual/migration.html
> [4] https://logging.staged.apache.org/log4j/2.x/jakarta.html
> [5] https://logging.staged.apache.org/log4j/2.x/soa.html
> [6] https://logging.staged.apache.org/log4j/2.x/manual/performance.html


Re: Integration tests

2024-08-10 Thread Ralph Goers
I believe I have asked for a log4j-its module for a while now since that is the 
only way you can validate modules actually work together. I am fine with it 
being in a separate repo.

Ralph

> On Aug 8, 2024, at 11:35 PM, Piotr P. Karwasz  wrote:
> 
> Hi all,
> 
> Unless I am mistaken, adding tests that run under JPMS is problematic
> in the `apache/logging-log4j2` repository. Even if I create a new
> Maven module for these tests:
> 
> * IntelliJ IDEA still complains that it doesn't know a
> `org.apache.logging.log4j.core` module.
> * These tests might be flaky, since the `module-info.class` file is
> destroyed before each compilation step and created right after it.
> 
> Should I create a new `apache/logging-log4j-its` repository for these
> tests? I can configure the CI to run them daily or after a snapshot
> has been generated.
> 
> Piotr
> 
> PS: Naming of the repo is as usual a problem.



Re: Should Log4j API bridges have a 3.x release?

2024-08-10 Thread Ralph Goers
I am fine with this plan.

Ralph

> On Aug 9, 2024, at 1:35 PM, Piotr P. Karwasz  wrote:
> 
> Hi Matt,
> 
> On Fri, 9 Aug 2024 at 20:29, Matt Sicker  wrote:
>> 
>> Well, one thing that changed in JUL is that it requires the java.logging 
>> module. Otherwise, the Java 8+ stuff is for the System.Logger API.
> 
> Right, maybe a 3.x version of `log4j-jul` would be useful. Besides the
> artifact has an optional dep on `log4j-core`. We might want to split
> it into 2 artifacts.
> Regarding `log4j-to-jul`, it is so rarely used, I don't see the point
> to maintain two identical versions.
> 
> Summarizing:
> 
> * `log4j-iostreams`, `log4j-slf4j-impl`, `log4j-slfj42-impl`,
> `log4j-to-jul` and `log4j-to-slf4j` could be removed from `main`.
> * `log4j-jpl` and `log4j-jul` should stay.
> 
> Do you agree?
> 
> Piotr