[
https://issues.apache.org/jira/browse/LOG4J2-1811?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15862948#comment-15862948
]
Matt Sicker commented on LOG4J2-1811:
-------------------------------------
I've been thinking about something similar lately, but I wasn't sure what the
problem could be described as. I do have some ideas:
* Combine the Plugins and Extending Log4j manual pages. The split is hard to
define, and the pages reference each other anyways.
* Possibly split up the appenders page so that each appender is a subpage. This
idea might be applicable elsewhere, but having huge pages by default can be
confusing. Perhaps generating both a per-page and single-page version of the
manual would be a good idea? Not sure how easy that is to do with the current
maven plugin.
* Replace code snippets, config snippets, etc., from manual with file includes
of the actual source. This way, changes to tests/etc. will have documentation
updates reflected.
* A tl;dr version of the manual would be neat. Give some sensible fast default
config files to start with, maybe help point users in the right direction for
advanced features.
> Log4j 2 configuration/usage ergonomics
> --------------------------------------
>
> Key: LOG4J2-1811
> URL: https://issues.apache.org/jira/browse/LOG4J2-1811
> Project: Log4j 2
> Issue Type: Epic
> Components: Configurators, Core
> Reporter: Remko Popma
>
> The vast majority of StackOverflow Log4j 2 questions is related to
> configuration. The Log4j 2 site offers an extensive manual but apparently
> many questions remain.
> This ticket aims to make Log4j 2 easier to configure and use. This can take
> many forms:
> * adding documentation
> * making documentation easier to find
> * detecting and addressing inconsistencies
> * facilitating debugging
> * showing richer error messages that help users diagnose problems
> * ... etc
> I am making this an epic so the effort can span multiple releases and include
> many big or small changes.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
