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 <piotr.karw...@gmail.com> 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