ruhulmus commented on PR #763:
URL: https://github.com/apache/logging-log4j2/pull/763#issuecomment-1093708523

   > logging-log4j-examples
   
   
   
   > @ruhulmus Thank you for your patience and persistence.
   > 
   > What you are proposing (if I understand correctly) is quite different from 
what we have at the moment.
   > 
   > * All of the submodules currently in the log4j project produce JAR files 
that are published to Maven Central. Each submodule contains a `src/main` 
folder where the source code for the artifact lives, a `src/test` folder for 
the test code (test JAR files are note published to Maven), and a `src/site` 
folder with some documentation for that submodule that will be converted to 
HTML and published on the Log4j web site.
   > * For documentation, we have "source" files under 
`logging-log4j2/src/site`: `src/site/asciidoc`, `src/site/markdown`, and 
`src/site/xdoc` (this is a bit cleaner in the 3.0 branch), these "source files" 
are converted to PDF and HTML and are published on the Log4j web site under 
https://logging.apache.org/log4j/2.x/manual
   > 
   > What you are proposing is a different kind of documentation, essentially 
an example project that people can either browse via GitHub's web interface, or 
clone/download to build and modify it locally.
   > 
   > This is an interesting idea, and I can see the value in something like 
that, not just for Async Loggers, but also for other features. (We have 
something similar in the https://github.com/apache/logging-log4j-audit-sample 
repo.)
   > 
   > It may make sense to create a separate github repo for this. Perhaps we 
can call it something like `logging-log4j-examples`. This could be a 
documentation-only repo, that is not intended to publish artifacts.
   > 
   > For the main Log4j repo (https://github.com/apache/logging-log4j), the 
threshold for accepting external contributions is quite high. One of the 
advantages of having a separate repo for example code is that we can be less 
strict about merging pull requests into that separate repo, so we can accept 
more contributions without spending much time on fine-tuning and polishing it.
   > 
   > I wonder what the other Log4j committers think of this?
   
   @remkop, Thank you for your valuable details explanation and feedback. I 
fully agree with you and that was my main intention to make this thing to share 
with the community. From my point of view, it's a good idea about the 
`logging-log4j-examples` repo or something like that. Lots of people are using 
`logging-log4S` for different types of projects. So it can be easier if the 
community found the related example in a single place. so people can share all 
the examples related to `logging-log4j` in the same repo. 
   
   if it is possible, how we can start it or What is the process we should 
follow? Do you have any idea ? What are the other `Log4j` committers think 
about it?
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@logging.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to