Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp the manual introduction #1468

Closed
Chealer opened this issue May 5, 2023 · 3 comments · Fixed by #2581
Closed

Revamp the manual introduction #1468

Chealer opened this issue May 5, 2023 · 3 comments · Fixed by #2581
Labels
documentation Pull requests or issues that affect documentation

Comments

@Chealer
Copy link

Chealer commented May 5, 2023

The manual's introduction page mostly consists of a Log4j 2 section. That section is somewhat long for an introduction, and it could be confusing. This ticket reports a few close issues:

  1. The paragraph initially seems to suggest that Log4j 1 is still maintained, saying "However, through the years development on it has slowed down."
  2. The paragraph implies that SLF4J+Logback and Log4j 2 are the only alternatives to Log4j 1, when several other logging frameworks (including Reload4j) exist.
  3. It is not clear what the list contains. It appears to be a comparison with both Log4j 1 and SLF4J+Logback. For example, it is unclear if "Support for custom log levels" is a benefit when compared to Log4j 1 only, SLF4J+Logback too, or even just the latter.
  4. The reasons for putting so much emphasis on a comparison with Log4j 1 are unclear, or even just outdated. It would be good to indicate that Log4j 1 has known vulnerabilities, but beyond that, I don't see why such an in-depth comparison would warrant inclusion in the introduction at this point.

I don't have a clear solution to propose, but I would first recommend to retitle the section "Log4j 1 and SLF4J+Logback" and reevaluate how prominent a comparison with Log4j 1 should remain. Another option would be to use a comparison matrix rather than a list.

@ppkarwasz ppkarwasz added the documentation Pull requests or issues that affect documentation label May 6, 2023
@rgoers
Copy link
Member

rgoers commented May 7, 2023

For reference, I expect the intro page was written for 2.0 and we have added new items to the list over time but never reviewed the page. At this point we should remove the references to Log4j 1.x since it has now been 8 years since we stopped supporting it.

grobmeier added a commit that referenced this issue Aug 7, 2023
grobmeier added a commit that referenced this issue Aug 7, 2023
@vy vy changed the title Manual: Introduction's Log4j 2 section is heavy/unclear Revamp the manual introduction Apr 26, 2024
@vy vy mentioned this issue Apr 26, 2024
5 tasks
@vy
Copy link
Member

vy commented Apr 26, 2024

@grobmeier
Copy link
Member

Port to 3.x: ca978bf

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests or issues that affect documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants