You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by fr...@apache.org on 2024/11/02 17:39:14 UTC
(logging-log4net) branch Feature/Antora updated: - cleaned up pom - migrated index and first paragraph of features to adoc
This is an automated email from the ASF dual-hosted git repository.
freeandnil pushed a commit to branch Feature/Antora
in repository https://gitbox.apache.org/repos/asf/logging-log4net.git
The following commit(s) were added to refs/heads/Feature/Antora by this push:
new 60fa2f1d - cleaned up pom - migrated index and first paragraph of features to adoc
60fa2f1d is described below
commit 60fa2f1d1f61834ada5f790cd61333f0bf40da37
Author: Jan Friedrich <fr...@apache.org>
AuthorDate: Sat Nov 2 18:38:36 2024 +0100
- cleaned up pom
- migrated index and first paragraph of features to adoc
---
pom.xml | 36 +--
src/site/antora/modules/ROOT/nav.adoc | 7 +-
src/site/antora/modules/ROOT/pages/index.adoc | 37 +--
.../ROOT/pages/log4j-changelog-maven-plugin.adoc | 157 ------------
.../antora/modules/ROOT/pages/log4j-changelog.adoc | 278 ---------------------
.../pages/log4j-docgen-asciidoctor-extension.adoc | 62 -----
.../ROOT/pages/log4j-docgen-maven-plugin.adoc | 116 ---------
.../antora/modules/ROOT/pages/log4j-docgen.adoc | 110 --------
8 files changed, 15 insertions(+), 788 deletions(-)
diff --git a/pom.xml b/pom.xml
index b38b881a..1eda606c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -16,16 +16,6 @@
~ limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" child.project.url.inherit.append.path="false" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-
- <!-- ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██
- ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██
- ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██
- ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
- ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
-
- `log4j-tools` project modules should use `log4j-tools-parent` as their parents, not this POM!
- This POM constitutes the BOM to be imported by applications using `log4j-tools` project modules. -->
-
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -34,36 +24,32 @@
<version>11.0.0</version>
</parent>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-tools-bom</artifactId>
+ <groupId>org.apache.logging.log4net</groupId>
+ <artifactId>apache-log4net</artifactId>
<version>${revision}</version>
<packaging>pom</packaging>
- <url>https://logging.apache.org/log4j/tools</url>
-
- <inceptionYear>2022</inceptionYear>
+ <name>Apache log4net</name>
+ <description>Logging framework for Microsoft .NET Framework.</description>
+ <url>https://logging.apache.org/log4net</url>
+ <inceptionYear>2004</inceptionYear>
<scm child.scm.connection.inherit.append.path="false" child.scm.developerConnection.inherit.append.path="false" child.scm.url.inherit.append.path="false">
- <connection>scm:git:git@github.com:apache/logging-log4j-tools.git</connection>
- <developerConnection>scm:git:git@github.com:apache/logging-log4j-tools.git</developerConnection>
- <tag>HEAD</tag>
- <url>https://github.com/apache/logging-log4j-tools</url>
+ <connection>scm:git:https://github.com/apache/logging-log4net</connection>
+ <developerConnection>scm:git:https://github.com/apache/logging-log4net</developerConnection>
+ <url>https://github.com/apache/logging-log4net</url>
</scm>
<issueManagement>
<system>GitHub Issues</system>
- <url>https://github.com/apache/logging-log4j-tools/issues</url>
+ <url>https://github.com/apache/logging-log4net/issues</url>
</issueManagement>
<ciManagement>
<system>GitHub Actions</system>
- <url>https://github.com/apache/logging-log4j-tools/actions</url>
+ <url>https://github.com/apache/logging-log4net/actions</url>
</ciManagement>
- <distributionManagement>
- <downloadUrl>https://logging.apache.org/log4j/tools</downloadUrl>
- </distributionManagement>
-
<properties>
<!-- project version -->
diff --git a/src/site/antora/modules/ROOT/nav.adoc b/src/site/antora/modules/ROOT/nav.adoc
index 37743285..4fa5645f 100644
--- a/src/site/antora/modules/ROOT/nav.adoc
+++ b/src/site/antora/modules/ROOT/nav.adoc
@@ -15,13 +15,8 @@
limitations under the License.
////
-* Components
-** xref:log4j-changelog.adoc[]
-** xref:log4j-changelog-maven-plugin.adoc[]
-** xref:log4j-docgen.adoc[]
-** xref:log4j-docgen-maven-plugin.adoc[]
-** xref:log4j-docgen-asciidoctor-extension.adoc[]
* xref:development.adoc[]
+* xref:features.adoc[]
* xref:release-notes.adoc[]
* {logging-services-url}/download.html[Download]
* {logging-services-url}/support.html[Support]
diff --git a/src/site/antora/modules/ROOT/pages/index.adoc b/src/site/antora/modules/ROOT/pages/index.adoc
index f0444748..7176d71a 100644
--- a/src/site/antora/modules/ROOT/pages/index.adoc
+++ b/src/site/antora/modules/ROOT/pages/index.adoc
@@ -15,38 +15,7 @@ See the License for the specific language governing permissions and
limitations under the License.
////
-= Log4j Tools
+= log4net
-Tooling **internally** used by {logging-services-url}/log4j/2.x/[the Apache Log4j project] infrastructure:
-
-* xref:log4j-changelog.adoc[]
-* xref:log4j-changelog-maven-plugin.adoc[]
-* xref:log4j-docgen.adoc[]
-* xref:log4j-docgen-maven-plugin.adoc[]
-* xref:log4j-docgen-asciidoctor-extension.adoc[]
-
-[#maven-bom]
-== Maven Bill of Materials (BOM)
-
-To keep your {project-name} module versions aligned, a https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms[Maven Bill of Materials (BOM) POM] is provided for your convenience.
-
-To use this with Maven, add the dependency listed below to your `pom.xml` file.
-Note that the `<dependencyManagement>` nesting and the `<scope>import</scope>` instruction.
-This will _import_ all modules bundled with the associated Log4j release to your `dependencyManagement`.
-As a result, you don't have to specify versions of the imported modules (`log4j-changelog`, `log4j-docgen`, etc.) while using them as a `<dependency>`.
-
-.`pom.xml` snippet importing `log4j-tools-bom`
-[source,subs="+attributes"]
-----
-<dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-tools-bom</artifactId>
- <version>{project-version}</version>
- <scope>import</scope>
- <type>pom</type>
- </dependency>
- </dependencies>
-</dependencyManagement>
-----
+The Apache log4net library is a tool to help the programmer output log statements to a variety of output targets.
+For more information on log4net see the xref:features.adoc[] document.
\ No newline at end of file
diff --git a/src/site/antora/modules/ROOT/pages/log4j-changelog-maven-plugin.adoc b/src/site/antora/modules/ROOT/pages/log4j-changelog-maven-plugin.adoc
deleted file mode 100644
index c4d9a473..00000000
--- a/src/site/antora/modules/ROOT/pages/log4j-changelog-maven-plugin.adoc
+++ /dev/null
@@ -1,157 +0,0 @@
-////
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-////
-
-= Log4j Changelog Maven Plugin
-
-This project ships a Maven plugin providing access to the `ChangelogExporter` and `ChangelogReleaser` of xref:log4j-changelog.adoc[Log4j Changelog].
-
-[#dependencies]
-== Dependencies
-
-You need to have the `org.apache.logging.log4j:log4j-changelog-maven-plugin` dependency in your classpath:
-
-[source,xml,subs="+attributes"]
-----
-<plugin>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-changelog-maven-plugin</artifactId>
- <version>{project-version}</version>
-</plugin>
-----
-
-[#export]
-== Exporting changelogs
-
-_Exporting_ changelogs is the act of feeding provided changelog and release information into {freemarker-link} templates to generate certain files; e.g., release notes for the website.
-There are two types template files supported:
-
-xref:log4j-changelog.adoc#changelog-template[Changelog templates]::
-These templates are rendered with the release and changelog information of a particular release.
-These are generally used to generate release notes for a particular release.
-
-xref:log4j-changelog.adoc#index-template[Index templates]::
-These templates are rendered with the release information of all releases.
-These are generally used to generate the index page referencing to release notes of each release.
-
-See xref:#export[the Log4j Changelog documentation] for further details.
-
-You can use the `export` goal as follows:
-
-.`build > plugins` block entry of `pom.xml`
-[source,xml,subs="+attributes"]
-----
-<!-- Export AsciiDoc-formatted release notes -->
-<plugin>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-changelog-maven-plugin</artifactId>
- <version>{project-version}</version>
- <inherited>false</inherited>
- <configuration>
- <indexTemplates>
- <template>
- <source>.index.adoc.ftl</source>
- </template>
- </indexTemplates>
- <changelogTemplates>
- <template>
- <source>.release-notes.adoc.ftl</source>
- <target>%v.adoc</target>
- </template>
- </changelogTemplates>
- </configuration>
- <executions>
- <execution>
- <id>generate-changelog</id>
- <goals>
- <goal>export</goal>
- </goals>
- </execution>
- </executions>
-</plugin>
-----
-
-`export` goal by default runs during the `pre-site` phase and accepts the following configuration:
-
-`skip` (parameter)::
-Indicates if the execution should be skipped or not.
-It defaults to `false` and can be set using the `log4j.changelog.skip` property.
-
-`changelogDirectory` (parameter)::
-Directory containing release folders composed of changelog entry XML files.
-It defaults to `${project.basedir}/src/changelog` and can be set using the `log4j.changelog.directory` property.
-
-`outputDirectory` (parameter)::
-Directory to write rendered templates.
-It defaults to `${project.build.directory}/generated-sources/site/changelog` and can be set using the `log4j.changelog.exporter.outputDirectory` property.
-
-`indexTemplates` (parameter)::
-List of xref:#export-template-type[template]s that will be rendered with release information of all releases.
-See xref:log4j-changelog.adoc#index-template[the index template file documentation] for details.
-
-`changelogTemplates` (parameter)::
-List of xref:#export-template-type[template]s that will be rendered with release and changelog information of a particular release.
-See xref:log4j-changelog.adoc#changelog-template[the changelog template file documentation] for details.
-
-[#export-template-type]
-`Template` (type)::
-An object composed of following fields:
-+
-`source` (parameter):::
-the {freemarker-link} template file
-
-`target` (parameter):::
-The output file.
-If not provided, it will be derived from the `source`: if the `source` is `.index.adoc.ftl`, the `target` will be set to `index.adoc`.
-If the value contains a `%v` (e.g., `%v.adoc`), it will be replaced with the associated release version.
-`%v` substitution is only allowed for changelog templates and will not work for index templates.
-
-`failIfNotFound` (parameter):::
-Indicates if export should fail when the source cannot be found.
-Defaults to `false`.
-
-[#release]
-== Populating a release changelog directory
-
-You can use the `release` goal wrapping xref:log4j-changelog.adoc#qa-deploy-release[`ChangelogReleaser` to populate a release changelog directory].
-An example usage is shared below.
-
-.Populate `src/changelog/2.19.0` from `src/changelog/.2.x.x`
-[source,bash]
-----
-./mvnw -N log4j-changelog:release -Dlog4j.changelog.releaseVersion=2.19.0
-----
-
-Note that above we are using `-N` (`--non-recursive`) to avoid visiting submodules, which also makes the run faster.
-
-`release` goal does not have default phase and accepts the following configuration parameters:
-
-`skip` (parameter)::
-Indicates if the execution should be skipped or not.
-It defaults to `false` and can be set using the `log4j.changelog.skip` property.
-
-`changelogDirectory` (parameter)::
-Directory containing release folders composed of changelog entry XML files.
-It defaults to `${project.basedir}/src/changelog` and can be set using the `log4j.changelog.directory` property.
-
-`releaseVersion` (parameter)::
-The version to be released.
-It can be set using the `log4j.changelog.releaseVersion` property.
-
-`versionPattern` (parameter)::
-The regular expression pattern for parsing versions.
-The pattern must provide the following named groups: `major`, `minor`, and `patch`.
-It defaults to `^(?<major>0|[1-9]\d*)\.(?<minor>0|[1-9]\d*)\.(?<patch>0|[1-9]\d*(-[a-zA-Z][0-9a-zA-Z-]*)?)$` and can be set using the `log4j.changelog.versionPattern` property.
diff --git a/src/site/antora/modules/ROOT/pages/log4j-changelog.adoc b/src/site/antora/modules/ROOT/pages/log4j-changelog.adoc
deleted file mode 100644
index c75536fa..00000000
--- a/src/site/antora/modules/ROOT/pages/log4j-changelog.adoc
+++ /dev/null
@@ -1,278 +0,0 @@
-////
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-////
-
-= Log4j Changelog
-
-This project contains tools to maintain changelogs.
-It is designed for Apache Log4j, but can be used for any Java project.
-
-[#dependencies]
-== Dependencies
-
-You need to have the `org.apache.logging.log4j:log4j-changelog` dependency in your classpath:
-
-[source,xml,subs="+attributes"]
-----
-<dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-changelog</artifactId>
- <version>{project-version}</version>
-</dependency>
-----
-
-Java module name and OSGi `Bundle-SymbolicName` are set to `org.apache.logging.log4j.changelog`.
-
-[#what-is-a-changelog]
-== What is a changelog?
-
-A changelog is a log of all notable changes made to a project.
-
-[#why-different]
-== Why yet another changelog tool?
-
-Existing changelog practices (e.g., https://keepachangelog.com[Keep a changelog], https://maven.apache.org/plugins/maven-changes-plugin/[maven-changes-plugin]) store changelog entries in the same file.
-This creates merge conflicts between different branches.
-Imagine multiple people working on multiple branches each containing a change to `CHANGELOG.md`.
-Whoever succeeds in merging their branch to `main` first will cause a merge-conflict for the others, even though their work might be totally unrelated from each other.
-
-This project embraces a model where changelog entries are kept in separate files and hence are not prone to merge conflicts.
-Similar to `maven-changes-plugin`, changelog sources and their exports (e.g., AsciiDoc-formatted) are split by design.
-
-[#look]
-== What does it look like?
-
-All changelog _sources_ and templates used to _export_ them are stored in folders under _the changelog directory_ (e.g., `/src/changelog`):
-
-[source]
-----
-$ tree -a src/changelog
-├── 2.18.0 # <1>
-│ ├── LOG4J2-3424_Properties_defined_in_configuration_using_a_value_attribute.xml # <4>
-│ ├── LOG4J2-3425_Syslog_appender_lacks_the_SocketOptions_setting.xml # <4>
-│ ├── LOG4J2-3426_Log4j_1_2_bridge_should_not_wrap_components_unnecessarily.xml # <4>
-│ ├── LOG4J2-3427_Improves_ServiceLoader_support_on_servlet_containers.xml # <4>
-│ ├── .release-notes.adoc.ftl # <5>
-│ └── .release.xml # <3>
-├── 2.19.0 # <1>
-│ ├── LOG4J2-3588_Allow_PropertySources_to_be_added.xml # <4>
-│ ├── LOG4J2-3590_Remove_SLF4J_1_8_x_binding.xml # <4>
-│ ├── LOG4J2-3614_Harden_InstantFormatter_against_delegate_failures.xml # <4>
-│ ├── LOG4J2-3556_JsonTemplateLayout_stack_trace_truncation_fix.xml # <4>
-│ ├── .release-notes.adoc.ftl # <5>
-│ └── .release.xml # <3>
-├── .2.x.x # <2>
-│ ├── LOG4J2-1284_redirect_old_javadoc_urls.xml # <4>
-│ └── .release-notes.adoc.ftl # <5>
-├── .changelog.adoc.ftl # <5>
-└── .index.adoc.ftl # <5>
-----
-<1> Changelog sources of _released versions_ are stored in `<changelogDirectory>/<releaseVersion>` folders (e.g., `src/changelog/2.19.0`)
-<2> Changelog sources of _upcoming releases_ are stored in `<changelogDirectory>/.<releaseVersionMajor>.x.x` folders (e.g., `/src/changelog/.2.x.x`)
-<3> `.release.xml` contains the information about the associated release.
-Note that upcoming release folders (e.g., `src/changelog/.2.x.x`) don't contain a `.release.xml`, since these releases are by definition not done yet.
-<4> All XML files not prefixed with a `.` (e.g., `src/changelog/.2.x.x/LOG4J2-3628_new_changelog_infra.xml`) constitute changelog entries
-<5> {freemarker-link} templates are used to _export_ this information to various forms; AsciiDoc-formatted pages for the website, Markdown-formatted files for GitHub Releases, etc.
-
-[#release-entry-file]
-== Release entry file
-
-A release entry file, `.release.xml`, consists of meta information regarding a particular release.
-A sample _release entry_ file is shared below.
-
-.`src/changelog/2.19.0/release.xml` file contents
-[source,xml]
-----
-<?xml version="1.0" encoding="UTF-8"?>
-<release xmlns="https://logging.apache.org/xml/ns"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="
- https://logging.apache.org/xml/ns
- https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
- date="2022-09-09"
- version="2.19.0"/>
-----
-
-Note that upcoming release folders (e.g., `src/changelog/.2.x.x`) don't contain a `.release.xml`, since these releases are by definition not done yet.
-
-[#changelog-entry-file]
-== Changelog entry file
-
-A changelog entry file consists of short meta information regarding a particular change.
-They are named following the `[<issueId>_]<shortSummary>.xml` pattern.
-Consider the following examples:
-
-* `LOG4J2-3556_JsonTemplateLayout_stack_trace_truncation_fix.xml`
-* `LOG4J2-3578_Generate_new_SSL_certs_for_testing.xml`
-* `Update_jackson_2_11_0_2_11_2.xml`
-
-A sample _changelog entry_ file is shared below.
-
-.`src/changelog/2.19.0/LOG4J2-3556_JsonTemplateLayout_stack_trace_truncation_fix.xml` file contents
-[source,xml]
-----
-<?xml version="1.0" encoding="UTF-8"?>
-<entry xmlns="https://logging.apache.org/xml/ns"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="
- https://logging.apache.org/xml/ns
- https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
- type="fixed">
- <issue id="2443" link="https://github.com/apache/logging-log4j2/pull/2443"/>
- <description format="asciidoc">
- Make `JsonTemplateLayout` stack trace truncation operate for each label block
- </description>
-</entry>
-----
-
-Some remarks about the structure of changelog entry files:
-
-* The root element must be named `entry`
-* `entry.type` attribute is required and must be one of the change types:
-** `added` – for new features
-** `changed` – for changes in existing functionality
-** `deprecated` – for soon-to-be removed features
-** `fixed` – for any bug fixes
-** `removed` – for now removed features
-** `updated` – for dependency updates
-* `issue` element is optional, can occur multiple times, and, if present, must contain `id` and `link` attributes
-* There must be a single `description` element with non-blank content and `format` attribute
-
-[#export]
-== Exporting changelogs
-
-_Exporting_ changelogs is the act of feeding provided changelog and release information into {freemarker-link} templates to generate certain files; e.g., release notes for the website.
-There are two types template files supported:
-
-xref:#changelog-template[Changelog templates]::
-These templates are rendered with the release and changelog information of a particular release.
-These are generally used to generate release notes for a particular release.
-
-xref:#index-template[Index templates]::
-These templates are rendered with the release information of all releases.
-These are generally used to generate the index page referencing to release notes of each release.
-
-`ChangelogExporter` is responsible for performing the export operation.
-
-[#changelog-template]
-=== Changelog templates
-
-Changelog template files (e.g., `src/changelog/2.19.0/.release-notes.adoc.ftl` ) are rendered with the release and changelog information of a particular release using the following input data hash:
-
-* `release` → `ChangelogRelease`
-* `entriesByType` → `Map<ChangelogEntry.Type, List<ChangelogEntry>>`
-
-See `ChangelogRelease` and `ChangelogEntry` for details.
-
-These templates are generally used to generate release notes for a particular release.
-A sample changelog template file is shared below.
-
-.`src/changelog/2.19.0/.release-notes.adoc.ftl` file contents
-[source,asciidoc]
-----
-= ${release.version}<#if release.date?has_content> (${release.date})</#if>
-
-This release primarily contains bug fixes and minor enhancements.
-
-<#if entriesByType?size gt 0>== Changes
-<#list entriesByType as entryType, entries>
-
-=== ${entryType?capitalize}
-
-<#list entries as entry>
-* ${entry.description.text?replace("\\s+", " ", "r")}
-(<#list entry.issues as issue>${issue.link}[${issue.id}]<#if issue?has_next>, </#if></#list>)
-</#list>
-</#list>
-</#if>
-----
-
-[#index-template]
-=== Index templates
-
-Index template files (e.g., `src/changelog/.index.adoc.ftl`) are rendered with the release information of all releases using the following input data hash:
-
-* `releases` -> list of hashes containing following keys:
-** `version`
-** `date`
-
-These template files are generally used to generate the index page referencing to release notes of each release.
-A sample index template file is shared below.
-
-.`src/changelog/.index.adoc.ftl` file contents
-[source,asciidoc]
-----
-= Release changelogs
-
-<#list releases as release>
-* xref:${release.version}.adoc[${release.version}]<#if release.date?has_content> (${release.date})</#if>
-</#list>
-----
-
-[#qa]
-== Q&A
-
-[#qa-entry]
-=== How can I add an entry for a change I am about to commit?
-
-You have just committed, or better, about to commit a great feature you have been working on.
-Simply create a <<changelog-entry-file>> and commit it along with your change!
-
-[#qa-generate]
-=== How can I export changelogs to AsciiDoc, Markdown, etc. files?
-
-You need to use xref:log4j-changelog-maven-plugin.adoc#export[the `export` goal the Maven plugin].
-
-[#qa-deploy-release]
-=== I am about to deploy a new release. What shall I do?
-
-Just before a release, three things need to happen in the changelog sources:
-
-. *Changelog entry files needs to be moved* from the _upcoming_ release changelog directory `<changelogDirectory>/.<releaseVersionMajor>.x.x` to the _new_ release changelog directory `<changelogDirectory>/<releaseVersion>`
-. *Templates need to be copied* from the _upcoming_ release changelog directory to the _new_ release changelog directory, unless it already exists in the target
-. *`.release.xml` needs to be created* in the _new_ release changelog directory
-
-Due to the nature of release candidates, above steps might need to be repeated multiple times.
-
-[TIP]
-====
-Log4j _releases_ and _release candidates_ all get deployed to the same https://repository.apache.org/#stagingRepositories[_staging repository_].
-Their `pom.xml` files all contain the same release version, e.g., `2.19.0`.
-There are no `-rc1`, `-rc2`, etc. suffixes in the version of a release candidate.
-Once a release candidate voting reaches to a consensus for release, associated artifacts simply get promoted from the _staging_ to the _public_ repository.
-Hence, there are no differences between releases and release candidates from the point of view of changelogs.
-====
-
-How to carry out aforementioned changes are explained below in steps:
-
-. Populate the `<changelogDirectory>/<releaseVersion>` directory (e.g., `/src/changelog/2.19.0`) from the upcoming release changelog directory (e.g., `<changelogDirectory>/.2.x.x`) using the xref:log4j-changelog-maven-plugin.adoc#release[`release` Maven goal]:
-+
-[source,bash]
-----
-./mvnw log4j-changelog:release \
- -Dlog4j.changelog.directory=/path/to/changelog/directory \
- -Dlog4j.changelog.releaseVersion=X.Y.Z
-----
-. Verify that all changelog entry files are moved from `<changelogDirectory>/.<releaseVersionMajor>.x.x` directory (e.g., `/src/changelog/.2.x.x`)
-. Verify that `<changelogDirectory>/<releaseVersion>` directory (e.g., `/src/changelog/2.19.0`) is created, and it contains templates, changelog entry files, and a `.release.xml`
-+
-[IMPORTANT]
-====
-If `<changelogDirectory>/<releaseVersion>` directory (e.g., `/src/changelog/2.19.0`) already exists with certain content, `ChangelogReleaser` will only move new changelog entry files and override `.release.xml`; templates will not be overridden.
-This allows one to run `ChangelogReleaser` multiple times, e.g., to incorporate changes added to a release candidate.
-====
-. Edit the populated templates (e.g., update the release notes with a short summary paragraph)
-. `git add` the changes in the changelog directory (e.g., `/src/changelog`) and commit them
diff --git a/src/site/antora/modules/ROOT/pages/log4j-docgen-asciidoctor-extension.adoc b/src/site/antora/modules/ROOT/pages/log4j-docgen-asciidoctor-extension.adoc
deleted file mode 100644
index a3e69de9..00000000
--- a/src/site/antora/modules/ROOT/pages/log4j-docgen-asciidoctor-extension.adoc
+++ /dev/null
@@ -1,62 +0,0 @@
-////
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-////
-
-= Log4j Docgen AsciiDoctor extension
-
-While xref:log4j-docgen.adoc#descriptor-generator[the descriptor generator] converts Javadoc to AsciiDoc, it cannot resolve links.
-That is, it cannot blindly replace a `{@link example.MyAppender foo}` Javadoc snippet with a `\xref:MyAppender.adoc[foo]` AsciiDoc snippet instead.
-This is because, the mapping of types to AsciiDoc files are not available to the descriptor generator, but xref:log4j-docgen.adoc#documentation-generator[the documentation generator].
-That is, the descriptor generator doesn't know if the type will be mapped to `<className>.adoc` or `<artifactId>/<className>.adoc`.
-As a matter of fact, it should not need to know this either: descriptors capture immutable metadata, whereas documentation file structure can always change.
-To work around this, we convert `{@link example.MyAppender foo}` to `apiref:example.MyAppender[foo]` and provide an `apiref` inline AsciiDoc macro to resolve these while generating the documentation.
-
-`DocgenExtension` AsciiDoctor extension provides the `apiref` inline macro which can be configured using the below shared AsciiDoctor document attributes:
-
-`log4j-docgen-descriptor-dot-files-included`::
-Indicates if dot files (i.e., `.`-prefix file names) will be accepted in <<log4j-docgen-asciidoctor-extension-attribute-descriptor-path-matcher>>.
-This attribute defaults to `false`.
-
-[#log4j-docgen-asciidoctor-extension-attribute-descriptor-path-matcher]
-`log4j-docgen-descriptor-path-matcher`::
-The https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)[path pattern] (e.g., `glob:**/*.xml`) to locate files produced by xref:log4j-docgen.adoc#descriptor-generator[the descriptor generator].
-This attribute is *required*.
-
-`log4j-docgen-type-filter-exclude-pattern`::
-The regular expression to match against the types loaded from descriptors and determine if a type will be _excluded_ to generate links.
-This argument defaults to not exclude anything.
-
-`log4j-docgen-type-filter-include-pattern`::
-The regular expression to match against the types loaded from descriptors and determine if a type will be _included_ to generate links.
-This argument defaults to `.*`, that is, all loaded types will be used to generate links.
-
-`log4j-docgen-package-name-stripped`::
-Indicates if the package name will be stripped for unknown types.
-That is, if `true`, `apiref:some.unknown.Class[]` will be converted to `<code>Class</code>`; `<code>some.unknown.Class</code>`, otherwise.
-Note that this only applies to types where the label is not provided.
-This flag is disabled by default.
-
-[#log4j-docgen-type-target-template]
-`log4j-docgen-type-target-template`::
-The FreeMarker template to produce the link target for individual types documented, for instance:
-+
-[source]
-----
-#${sourcedType.groupId?replace('.', '-')}_${sourcedType.artifactId?replace('.', '-')}_${sourcedType.type.className?replace('.', '-')
-----
-
-+
-This attribute is *required*.
diff --git a/src/site/antora/modules/ROOT/pages/log4j-docgen-maven-plugin.adoc b/src/site/antora/modules/ROOT/pages/log4j-docgen-maven-plugin.adoc
deleted file mode 100644
index 7b728442..00000000
--- a/src/site/antora/modules/ROOT/pages/log4j-docgen-maven-plugin.adoc
+++ /dev/null
@@ -1,116 +0,0 @@
-////
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-////
-
-= Log4j Docgen Maven Plugin
-
-Log4j Docgen Maven Plugin allows you to easily run Log4j Docgen xref:log4j-docgen.adoc#documentation-generator[documentation generator] and xref:log4j-docgen.adoc#schema-generator[schema generator] from your `pom.xml`.
-
-[#dependencies]
-== Dependencies
-
-You need to have the `org.apache.logging.log4j:log4j-docgen-maven-plugin` dependency in your classpath:
-
-[source,xml,subs="+attributes"]
-----
-<plugin>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-docgen-maven-plugin</artifactId>
- <version>{project-version}</version>
-</plugin>
-----
-
-[#generate-documentation]
-== Generate documentation
-
-The `generate-documentation` goal generates an AsciiDoc-formatted documentation using FreeMarker templates that are fed with the types loaded from given descriptors:
-
-.An example `log4j-docgen:generate-documentation` configuration
-[source,xml,subs="+attributes"]
-----
-<configuration>
-
- <descriptorFileMatchers>
- <descriptorFileMatcher>
- <baseDirectory>${project.build.directory}/plugin-descriptors</baseDirectory>
- </descriptorFileMatcher>
- </descriptorFileMatchers>
-
- <typeFilter>
- <excludes>
- <exclude>^java\..+</exclude>
- </excludes>
- </typeFilter>
-
- <templateDirectory>${project.basedir}/src/docgen-templates</templateDirectory>
-
- <indexTemplates>
- <template>
- <source>index.adoc.ftl</source>
- <target>${project.build.directory}/generated-site/asciidoc/plugin-reference/index.adoc</target>
- </template>
- </indexTemplates>
-
- <typeTemplates>
- <template>
- <source>type.adoc.ftl</source>
- <target>${project.build.directory}/generated-site/asciidoc/plugin-reference/%g/%a/%c.adoc</target><!--1-->
- </template>
- </typeTemplates>
-
-</configuration>
-----
-<1> `target` must be in sync. with xref:log4j-docgen-asciidoctor-extension.adoc#log4j-docgen-type-target-template[the `log4j-docgen-type-target-template` configuration of `log4j-docgen-asciidoctor-extension`].
-
-The `generate-documentation` goal configuration also accepts the following parameters:
-
-`skip` (parameter)::
-Indicates if the execution should be skipped or not.
-It defaults to `false` and can be set using the `log4j.docgen.skip` property.
-
-[#generate-schema]
-== Generate schema
-
-The `generate-schema` goal generates an XSD derived from the types loaded using given descriptors:
-
-.An example `log4j-docgen:generate-schema` configuration
-[source,xml,subs="+attributes"]
-----
-<configuration>
-
- <descriptorFileMatchers>
- <descriptorFileMatcher>
- <baseDirectory>${project.build.directory}/plugin-descriptors</baseDirectory>
- </descriptorFileMatcher>
- </descriptorFileMatchers>
-
- <typeFilter>
- <excludes>
- <exclude>^java\..+</exclude>
- </excludes>
- </typeFilter>
-
- <schemaVersion>${project.version}</schemaVersion>
- <schemaFile>${project.build.directory}/generated-site/resources/config.xsd</schemaFile>
-
-</configuration>
-----
-
-The `generate-schema` goal configuration also accepts the following parameters:
-
-`skip` (parameter)::
-Indicates if the execution should be skipped or not.
-It defaults to `false` and can be set using the `log4j.docgen.skip` property.
diff --git a/src/site/antora/modules/ROOT/pages/log4j-docgen.adoc b/src/site/antora/modules/ROOT/pages/log4j-docgen.adoc
deleted file mode 100644
index d78e02ca..00000000
--- a/src/site/antora/modules/ROOT/pages/log4j-docgen.adoc
+++ /dev/null
@@ -1,110 +0,0 @@
-////
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-////
-
-= Log4j Docgen
-
-Log4j Docgen (Documentation Generation) bundles utility classes to generate documentation from Log4j plugins.
-Given almost all Log4j functionality (layouts, appenders, etc.) is implemented in the form of plugins, this project aims the following goals:
-
-Avoid the need to maintain documentation in multiple places::
-For instance, Log4j JSON Template Layout is composed of several plugins with sufficient Javadoc explaining their behaviour.
-Next to this we also maintain a big `json-template-layout.adoc` page for the website, again, documenting each component.
-By generating documentation from the source code, developers can precisely capture the behaviour of their components only in the very code itself that they change.
-
-Accurately capture the component configuration::
-It is pretty common that source code changes are not reflected to documentation.
-By generating the documentation from the source code, this discrepancy gets removed.
-
-[#dependencies]
-== Dependencies
-
-You need to have the `org.apache.logging.log4j:log4j-docgen` dependency in your classpath:
-
-[source,xml,subs="+attributes"]
-----
-<plugin>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-docgen</artifactId>
- <version>{project-version}</version>
-</plugin>
-----
-
-[#descriptor-generator]
-== Descriptor generator
-
-`DescriptorGenerator` is an annotation processor that generates an XML file capturing all the metadata needed to document a plugin:
-
-* **types** – types it extends from, types it uses in its configuration, etc.
-* **configuration** – extracts the necessary set of elements, attributes, etc. from builder classes, `@PluginFactory`-annotated methods, etc.
-* **documentation** – extracts the Javadoc of each field and type, and converts it to AsciiDoc
-
-Users are recommended to integrate this annotation processor into their build:
-
-[source,xml,subs="+attributes"]
-----
-<plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-compiler-plugin</artifactId>
- <configuration>
- <annotationProcessorPaths combine.children="append">
- <!-- Include `org.apache.logging.log4j.docgen.processor.DescriptorGenerator` that generates `log4j-plugins.xml`.
- `DescriptorGenerator` must precede `PluginProcessor`, since the latter *claims* the `@Plugin`.
- Once claimed, `javac` doesn't pass those sources to other processors. -->
- <path>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-docgen</artifactId>
- <version>{project-version}</version>
- </path>
- <!-- `org.apache.logging.log4j.core.config.plugins.processor.PluginProcessor` for generating `META-INF/org/apache/.../Log4j2Plugins.dat`: -->
- <path>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-core</artifactId>
- <version>${project.version}</version>
- </path>
- </annotationProcessorPaths>
- <compilerArgs combine.children="append">
- <!-- Provide `org.apache.logging.log4j.docgen.processor.DescriptorGenerator` arguments: -->
- <arg>-Alog4j.docgen.skip=false</arg><!-- optional (defaults to `false`) -->
- <arg>-Alog4j.docgen.descriptorFilePath=${project.build.directory}/${project.artifactId}-plugins.xml</arg>
- <arg>-Alog4j.docgen.groupId=${project.groupId}</arg>
- <arg>-Alog4j.docgen.artifactId=${project.artifactId}</arg>
- <arg>-Alog4j.docgen.version=${project.version}</arg>
- <arg>-Alog4j.docgen.description=${project.description}</arg>
- <arg>-Alog4j.docgen.typeFilter.excludePattern=^java\..+</arg>
- </compilerArgs>
- </configuration>
-</plugin>
-----
-
-[#documentation-generator]
-== Documentation generator
-
-`DocumentationGenerator` receives
-
-. plugin descriptors (generated by the `DescriptorGenerator`)
-. FreeMarker templates (to render the type hierarchy and each individual type)
-
-as input arguments, and produces an AsciiDoc-formatted documentation that one can integrate into the website of a project.
-
-Users are recommended to use xref:log4j-docgen-maven-plugin.adoc#generate-documentation[the `generate-documentation` goal of the `log4j-docgen-maven-plugin`] instead.
-
-[#schema-generator]
-== Schema generator
-
-`SchemaGenerator` receives plugin descriptors (generated by the `DescriptorGenerator`) as input, and produces an XSD describing the structure defined by the descriptors.
-
-Users are recommended to use xref:log4j-docgen-maven-plugin.adoc#generate-schema[the `generate-schema` goal of the `log4j-docgen-maven-plugin`] instead.