Hi Ralph, On Fri, 6 Sept 2024 at 01:46, Ralph Goers <ralph.go...@dslextreme.com> wrote: > Features: > > The GitHub actions workflows list several yaml files. This confuses me. Yaml > files don’t contain executable code so how do they accomplish any of the > features they list? Are these to configure specific GitHub Actions (Only > guessing since that is the name of the section).
99% of the build logic is in the POM file, even the website generation using Antora, so you don't need to download NPM yourself. The POM file is heavily commented on, but we probably can expand on that. The YAML files contain: * either simple actions like checkout repository, install Java, * or bash scripts mostly containing Git or Maven invocations. > XML schemas - what if you don’t want or have any? Will it break or generate a > bunch of error messages? XML schemas[1] are published outside of the release cycle. As you can imagine, the Log4j configuration schema is mostly there to help users with their basic needs. Once users start using arbiters or property substitution in places where we expect a `boolean`, `int` or `Level`, errors appear. We had a very productive discussion with Philip Hachey on how to allow property substitution everywhere and still profit from IDE suggestions[2]. [1] https://logging.apache.org/xml/ns/ [2] https://github.com/apache/logging-log4j2/pull/1441 > Usage: > Item 2 - I may need to add a .mvn/jvm.config. Why? A link to > https://maven.apache.org/configure.html#mvn-jvm-config-file should be > included. > Item 5 - Copy and adapt. It may be redundant with the usage page but a link > to the changelog plugin to tell you how to adapt them would be useful. > Item 6 - Again - adapt them. This presumes you already know what Antora is > and how to configure it. Thanks for the suggestions. You can apply them to the website by using the [Edit this page] link in the upper right corner of the page. It will redirect you to the appropriate AsciiDoc file in the Git repo. All the modifications to the repo documentation are automatically staged on `logging.staged.apache.org`. To push them to the production site, you need to cherry pick them onto the `<code_branch>-site-pro` branch. Note that on our main repo the `2.x-site-pro` and `main-site-pro` branches do not exist yet. They will be created after the first releases. > Is there an archetype or set of archetypes I can use to generate a new > project? Adding `logging-parent` as parent POM should be enough. Some features are activated based on existing files (e.g. documentation requires a src/site folder). We can probably create a `logging-archetype` repo with a minimalistic project that shows all the features. Piotr
