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 Configuration page #2525

Closed
3 tasks done
vy opened this issue Apr 26, 2024 · 2 comments · Fixed by #2574
Closed
3 tasks done

Revamp the Configuration page #2525

vy opened this issue Apr 26, 2024 · 2 comments · Fixed by #2574
Assignees
Labels
documentation Pull requests or issues that affect documentation

Comments

@vy
Copy link
Member

vy commented Apr 26, 2024

Due to the fast development lifecycle of Log4j 2, the configuration options documented in the configuration page and those effectively available in the code are currently out-of-sync.

The purpose of this task is to:

  • check the documentation of Log4j System Properties with their usage in the code,
  • if they differ, fix either the documentation page or the code,
  • simplify and restructure the page.

Configuration page outline

As agreed in the site structure document, revamp the "Configuration" page such that

  • Outline:
    • Supported formats
      • General structure of configuration file
      • How do formats map to each other?
    • Basics
      • Very briefly explain appender, logger, etc.
      • Refer to the “Architecture” page for details
    • Properties
      • Mention about fuzzy matching
      • List them in definition list (for main artifacts)
    • Recipes
      • Examples for common use cases
    • Links to the “Guides” page contents
    • Programmatic configuration
  • Fix LOG4J2-3684
  • Target 2.x, port to main
@vy vy added the documentation Pull requests or issues that affect documentation label Apr 26, 2024
@ppkarwasz ppkarwasz self-assigned this Apr 26, 2024
@ppkarwasz
Copy link
Contributor

ppkarwasz commented Apr 30, 2024

The following "documentation" problems were fixed by adapting the code to the documented behavior:

@ppkarwasz
Copy link
Contributor

ppkarwasz commented May 3, 2024

The following documentation changes were applied:

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.

2 participants