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

Merged
merged 24 commits into from May 16, 2024
Merged

Revamp Configuration page #2574

merged 24 commits into from May 16, 2024

Conversation

ppkarwasz
Copy link
Contributor

Closes #2525

This PR provides an almost complete rewrite of the current Configuration page, based on these principles:

  • every example of configuration file (except those that apply only to a single format) is provided in all standard configuration formats,
  • the page is sorted so that the syntax of the configuration file is provided first, followed by the most commonly used elements. Advanced settings are either at the end of the page or on separate pages.

Most notably:

We also sort the chapters contained in the Manual, so that the chapters dealing with configuration are close to each other.

@ppkarwasz ppkarwasz mentioned this pull request May 12, 2024
3 tasks
@ppkarwasz ppkarwasz requested review from grobmeier and vy May 12, 2024 12:16
@vy vy mentioned this pull request May 13, 2024
5 tasks
Copy link
Member

@vy vy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me start with some unavoidable remarks:

  • Excellent job with porting config snippets to all supported file formats and annotating them precisely! 🙇
  • Thanks so much for using JTL in examples by default. It certainly will help us to get fewer user inquires claiming PatternLayout needs a CVE. 😍
  • Awesome job in covering the complete surface of configuration, which is a big ball of mud.
  • A very large configuration knob set is swiftly contained in a succinct, cohesive sectioning.

@ppkarwasz ppkarwasz requested a review from vy May 15, 2024 11:13
@ppkarwasz ppkarwasz merged commit af0ca29 into 2.x May 16, 2024
9 checks passed
@ppkarwasz ppkarwasz deleted the doc/2.x/configuration branch May 16, 2024 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revamp the Configuration page
3 participants