Re: [log4j] Revamping Log4j website & manual tooling

2023-12-21 Thread Volkan Yazıcı
On Wed, Dec 20, 2023 at 10:56 PM Christian Grobmeier wrote: > We = you & Piotr? I was surprised to find out you were having a meeting > for a milestone that also included me. > It wasn't a meeting, but a casual unplanned brain-storming session, which we do several times every day with Piotr. I d

Re: [log4j] Revamping Log4j website & manual tooling

2023-12-20 Thread Christian Grobmeier
On Wed, Dec 20, 2023, at 17:50, Volkan Yazıcı wrote: > On Wed, Dec 20, 2023 at 5:05 PM Christian Grobmeier > wrote: > >> I see only one mention of Antora, the tool you are proposing. > > > I am indeed **not** proposing Antora (removed its mentions), but plain > AsciiDoc, which is exactly what we h

Re: [log4j] Revamping Log4j website & manual tooling

2023-12-20 Thread Volkan Yazıcı
On Wed, Dec 20, 2023 at 5:05 PM Christian Grobmeier wrote: > I see only one mention of Antora, the tool you are proposing. I am indeed **not** proposing Antora (removed its mentions), but plain AsciiDoc, which is exactly what we have in Log4j, Log4j Kotlin, Log4j Scala, Log4j Tools, Log4j Trans

Re: [log4j] Revamping Log4j website & manual tooling

2023-12-20 Thread Christian Grobmeier
I see only one mention of Antora, the tool you are proposing. You don't have to sell us Asciidoc; we all have our opinions about it; the majority of the document is about "why not" but little "why Antora" I would be more interested in the challenges/benefits of Antora, and how such a system cou

[log4j] Revamping Log4j website & manual tooling

2023-12-20 Thread Volkan Yazıcı
As a part of the planned Log4j website & manual revamp , my proposal is to stick to what we already have (i.e., AsciiDoc) and just automate the publication

Re: [log4j] Revamping Log4j website & manual structure

2023-12-19 Thread Volkan Yazıcı
*[We can indeed discuss this further in the video call.]* If I am not mistaken, you were a big fan of PostgreSQL's website – correct me if I am wrong. The current structure is pretty much analogous to what they have: a set of common pages (about, support, tutorials, etc.) and major-version-specifi

Re: [log4j] Revamping Log4j website & manual structure

2023-12-19 Thread Gary Gregory
Hi all, Thank you V for putting this together. >From a high level, I don't like that the proposal is split into a website and a manual. The material should be the same and obviously optionally differently as a site vs a manual. For example, why is the tutorial excluded from the manual? Anyway, th

[log4j] Revamping Log4j website & manual structure

2023-12-19 Thread Volkan Yazıcı
*TLDR:* Log4j website & manual structure (i.e., sectioning) will be changed. Please reply for feedback and/or support. As a part of the planned Log4j website & manual revamp , I ask for your feedback on the structure Christian, Piot

Re: [log4j] Revamping Log4j website & manual

2023-12-18 Thread Gary Gregory
When I read "pages", "site", and do on, I am reminded of the model-view paradigm. I would offer that we focus on _content_ first, and write that content in some general format that tooling can then be used to generate a site, a PDF, Javadoc, whatever. FWIW, when I worked on the "Java Persistence w

Re: [log4j] Revamping Log4j website & manual

2023-12-18 Thread Matt Sicker
I’d be interesting in helping with this, particularly around plugin development docs which are somewhat anemic. I’ve got several things to document in a non-API-doc fashion from the new DI system and such, too. > On Dec 18, 2023, at 1:13 PM, Volkan Yazıcı wrote: > > *TLDR:* Log4j websites & ma

[log4j] Revamping Log4j website & manual

2023-12-18 Thread Volkan Yazıcı
*TLDR:* Log4j websites & manual will be rewritten. Feedback and support are more than welcome. Starting from February, Christian, Piotr, and I will be working on reorganizing the Log4j websites (Log4j, Log4j Scala, Log4j Tools, etc.) and rewriting the Log4j manual. Many implementation details are