-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Revamp Configuration
page
#2574
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
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
vy
reviewed
May 13, 2024
There was a problem hiding this 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.
src/site/antora/modules/ROOT/examples/configuration/arbiters-select.json
Outdated
Show resolved
Hide resolved
src/site/antora/modules/ROOT/examples/configuration/arbiters.json
Outdated
Show resolved
Hide resolved
src/site/antora/modules/ROOT/examples/configuration/filters.xml
Outdated
Show resolved
Hide resolved
src/site/antora/modules/ROOT/examples/configuration/main-elements.json
Outdated
Show resolved
Hide resolved
src/site/antora/modules/ROOT/examples/configuration/main-elements.json
Outdated
Show resolved
Hide resolved
src/site/antora/modules/ROOT/examples/configuration/arbiters-select.json
Outdated
Show resolved
Hide resolved
vy
reviewed
May 13, 2024
vy
reviewed
May 14, 2024
Co-authored-by: Volkan Yazıcı <volkan@yazi.ci>
Co-authored-by: Volkan Yazıcı <volkan@yazi.ci>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2525
This PR provides an almost complete rewrite of the current Configuration page, based on these principles:
Most notably:
Configuration properties
andScripts
are rarely used (exceptlog4j2.configurationFile
), so they are moved to a separate page,We also sort the chapters contained in the Manual, so that the chapters dealing with configuration are close to each other.