There are several reasons that a single `README.adoc` will not suffice for `logging-parent`:
1. It bundles plenty of functionality (reusable CI workflows, profiles for creating distributions, maintaining release notes, etc.) that needs to be documented. 2. It is the foundation of the new CI-based release process. Its release instructions apply to downstream (`log4j-kotlin`, `log4j-scala`, `log4j-tools`, `log4j-transform`, etc.) and documentation associated with that better be hosted at a central location rather than being cloned everywhere. 3. I am working on aligning the way repositories generate and publish their documentation; `./mvnw site`, AsciiDoc files located under `src/site`, Maven profile for populating `src/site/_constants.adoc`, etc. This will enable us to automate this generation and publication process. `logging-parent` is no exception to that. On Thu, Sep 28, 2023 at 5:24 PM Ralph Goers <ralph.go...@dslextreme.com> wrote: > Why does log4j-parent need a web site? Why isn’t there README in the Git > repo enough? > > Ralph > > > On Sep 26, 2023, at 2:12 PM, Matt Sicker <m...@musigma.org> wrote: > > > > You can add an asf-site (and asf-staging) branch to logging-parent to > get a website published. You can create a branch in git without any commits > in its history to start it. > > — > > Matt Sicker > > > >> On Sep 26, 2023, at 14:00, Volkan Yazıcı <vol...@yazi.ci> wrote: > >> > >> *Summary:* I want to place the website of `logging-parent` to ` > >> logging.apache.org/parent` <http://logging.apache.org/parent> served > from a to-be-created > >> `logging-parent-site` repository. Objections? > >> > >> `logging-parent` version `10.1.0` is ready to be released with plenty of > >> features. I want it to play a role model for the rest of the Maven-based > >> Logging Services projects in terms of how its artifacts, distribution, > and > >> website is deployed. Though the last bit, "website", is missing. Since > >> `10.1.0` includes plenty of documentation, I have converted it to a > >> website: checkout the `main` branch of `logging-parent` and try `./mvnw > >> site && python -m http.server -d target/site`. > >> > >> Note for Ralph and for those interested: No, this is not the Antora > website > >> combining multiple websites, etc. This is plain `maven-asciidoc-plugin` > >> execution against a bunch of AsciiDoc files under `src/site`. The same > is > >> already practiced in `log4j-scala` and `log4j-kotlin` too. I want to > adopt > >> this in `log4j-tools` and `log4j-transform` as well. > > > >
