You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2023/11/15 15:29:51 UTC
(logging-log4j-jmx-gui) 02/04: Add the website
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j-jmx-gui.git
commit d49b7d250386b421d0b185a37982e4804f59806e
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Wed Nov 15 16:23:26 2023 +0100
Add the website
---
.github/workflows/build.yaml | 2 +-
README.adoc | 47 +------
RELEASE-NOTES.md | 21 ---
RELEASING.adoc | 156 ---------------------
src/changelog/.2.x.x/add-site.xml | 9 ++
.../_2.x.x.adoc => _constants.adoc} | 42 ++----
.../_2.x.x.adoc => _constants.tmpl.adoc} | 42 ++----
doc/manual.adoc => src/site/_manual.adoc | 36 +++--
src/site/_release-notes/_2.x.x.adoc | 1 +
src/site/index.adoc | 92 ++++++++++++
{doc => src/site}/jmx-jconsole-editconfig.png | Bin
{doc => src/site}/jmx-jconsole-statuslogger.png | Bin
{doc => src/site}/jmx-standalone-editconfig.png | Bin
{doc => src/site}/jmx-standalone-statuslogger.png | Bin
14 files changed, 149 insertions(+), 299 deletions(-)
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index d1c192a..eadc9c0 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -71,4 +71,4 @@ jobs:
contents: write
with:
project-id: log4j-jmx-gui
- distribution-attachment-count: 1
+ site-enabled: true
diff --git a/README.adoc b/README.adoc
index e75d206..b0c8fde 100644
--- a/README.adoc
+++ b/README.adoc
@@ -21,49 +21,4 @@ https://www.apache.org/licenses/LICENSE-2.0.txt[image:https://img.shields.io/git
This project provides a Swing-based client for remotely editing the Log4j configuration and remotely monitoring `StatusLogger` output.
It can be run as a standalone application or as a JConsole plugin.
-
-This project contains the parent POM and the reusable GitHub Actions workflows **internally** used by other Maven-based https://logging.apache.org[Apache Logging Services projects].
-
-== Build
-
-This project requires Java 17 for compilation.
-You can build using `./mvnw verify` command.
-
-== Usage
-
-See xref:doc/manual.adoc[the manual] for usage instructions.
-
-== Distribution
-
-In accordance with the Apache Software Foundation's release https://infra.apache.org/release-distribution.html[distribution policy] and https://infra.apache.org/release-publishing.html[creation process], project artifacts are _officially_ accessible from the following locations:
-
-* ASF https://repository.apache.org/content/repositories/releases[Release] and https://repository.apache.org/content/repositories/snapshots[snapshot] repositories (mirrored to https://central.sonatype.dev/[the Maven Central Repository])
-* ASF https://downloads.apache.org/logging/log4j-jmx-gui[Distribution directory]
-
-See xref:RELEASING.adoc[release instructions] for further details.
-
-=== CycloneDX Software Bill of Materials (SBOM)
-
-Starting with version `2.22.0`, this project distributes https://cyclonedx.org/capabilities/sbom/[CyclenoDX Software Bill of Materials (SBOM)] along with each deployed artifact.
-This is streamlined by `logging-parent`, see https://logging.apache.org/logging-parent/latest/#cyclonedx-sbom[its website] for details.
-
-== Support
-
-Please keep in mind that this project is intended for internal usage only.
-You can use GitHub Issues for feature requests and bug reports – not questions!
-See https://logging.apache.org/log4j/2.x/support.html[the Log4j support policy] for details.
-
-== Security
-
-If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:security@logging.apache.org[the Log4j security mailing list].
-See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details.
-
-== License
-
-Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
-See xref:NOTICE.txt[] 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.
+See https://logging.apache.org/log4j/jmx-gui[the project website] for details.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
deleted file mode 100644
index ca933c8..0000000
--- a/RELEASE-NOTES.md
+++ /dev/null
@@ -1,21 +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
- ~
- ~ http://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.
- -->
-
-This project uses `log4j-changelog-maven-plugin` [log4j-changelog-maven-plugin](https://github.com/apache/logging-log4j-tools/tree/main/log4j-changelog-maven-plugin) for keeping a changelog and generating release notes.
-
-Changelog files are located under [`src/changelog`](src/changelog).
-Release notes can be generated using `./mvnw -N -P changelog-export` command.
diff --git a/RELEASING.adoc b/RELEASING.adoc
deleted file mode 100644
index f0dcbc5..0000000
--- a/RELEASING.adoc
+++ /dev/null
@@ -1,156 +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.
-////
-
-// ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██
-// ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██
-// ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██
-// ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
-// ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
-//
-// Below instructions are shared by all Maven-based Apache Logging Services projects.
-// Be extremely cautious while making changes!
-
-// Configuration ///////////////////////////////////////////////////////////////
-
-// Name of the GitHub repository; `logging-parent`, `logging-log4j2`, `logging-log4j-tools`, etc.
-:repository-name: logging-log4j-jmx-gui
-
-// Name of the project; `logging-parent`, `log4j`, `log4j-tools`
-:project-name: log4j-jmx-gui
-
-// Instructions ////////////////////////////////////////////////////////////////
-
-= Release instructions
-
-[WARNING]
-====
-In the code examples below, assuming the version to be released is `7.8.0`.
-====
-
-== Stage the release
-
-. Create and push the release branch:
-+
-[source,bash]
-----
-git fetch -p
-git checkout -B release/7.8.0 origin/main
-git push origin release/7.8.0
-----
-. Verify that the associated https://github.com/apache/{repository-name}/actions[GitHub Actions workflow] succeeds:
-.. `revision` property in `pom.xml` is updated
-.. Changelog is released (i.e., `src/changelog/7.8.0` folder is populated)
-.. *Signed artifacts* are uploaded to the _Staging Repositories_ in https://repository.apache.org/[repository.apache.org]
-.. *Signed distribution and its checksum* (e.g., `apache-{project-name}-7.8.0-{bin,src}.{zip,.zip.asc,.zip.sha512}`) are uploaded to https://dist.apache.org/repos/dist/dev/logging/log4j[dist.apache.org/repos/dist/**dev**/logging/log4j] Subversion repository (along with auxiliary files; email texts, etc.)
-
-+
-If not, commit necessary fixes, push, and repeat.
-
-+
-[TIP]
-====
-GitHub Actions workflow is idempotent.
-You can iterate on the `release/7.8.0` branch to perfect it.
-====
-. _Close_ the repository in https://repository.apache.org/[repository.apache.org]
-
-== Vote the release
-
-. Send the vote email uploaded to the https://dist.apache.org/repos/dist/dev/logging/log4j[dist.apache.org/repos/dist/**dev**/logging/log4j] Subversion repository
-+
-[WARNING]
-====
-**Fix the cited https://repository.apache.org[repository.apache.org] URL** in the generated email!
-It changes after every Nexus deployment.
-====
-+
-[WARNING]
-====
-Make sure your email is sent in plain text, that is, https://infra.apache.org/contrib-email-tips#nohtml[no HTML]!
-If you are using GMail, simply enable the _"Plain text mode"_ while composing your message.
-====
-
-. Once the consensus is reached within the set time frame, respond to the first post in the thread as follows:
-+
-[source]
-----
-Adding my +1.
-
-With that, the release passes with 3 binding +1 votes from <PMC-member-1>, ..., <PMC-member-N>, and me.
-I will continue the release process.
-----
-
-== Publish the release
-
-=== In the git repository
-
-. Pull the most recent changes and tags
-+
-[source,bash]
-----
-git fetch -p
-----
-. Tag the release (e.g., `rel/7.8.0`) and push it
-+
-[source,bash]
-----
-git tag -a rel/7.8.0 <COMMIT-ID> -m 7.8.0 # <1>
-git push origin rel/7.8.0
-----
-+
-<1> You can find the `COMMIT-ID` in the generated vote email.
-+
-[IMPORTANT]
-====
-The ASF infrastructure treats ``rel/``-prefixed git tags special and ensures they are immutable for provenance reasons.
-====
-. Merge `release/7.8.0` to `main`
-+
-[source,bash]
-----
-git checkout main
-git merge release/7.8.0
-----
-. Set the revision property to the next development version (e.g., `7.9.0-SNAPSHOT`) in xref:pom.xml[`pom.xml`]
-. Commit changes and push the `main` branch
-. Delete the local and remote copies of the `release/7.8.0` branch
-
-=== In the ASF infrastructure
-
-. _Release_ the repository in https://reporter.apache.org/addrelease.html?logging[repository.apache.org]
-. In https://dist.apache.org/repos/dist/release/logging/{project-name}[dist.apache.org/repos/dist] Subversion repository,
-.. create the `*release*/logging/{project-name}/7.8.0` folder, and copy the signed sources and their checksum from `*dev*/logging/{project-name}` to there
-.. delete the folder from an earlier release in `*release*/logging/{project-name}` (stash the generated announcement email somewhere, you will need it later on)
-.. commit changes
-. Report the release at https://reporter.apache.org/addrelease.html?logging[reporter.apache.org]
-
-=== In GitHub
-
-Once the artifacts are visible in https://central.sonatype.dev/[central.sonatype.dev], https://github.com/apache/{repository-name}/releases/new[create a new release in GitHub]
-
-. Use the `rel/7.8.0` tag
-. Copy release notes from the generated emails
-
-== Announce the release
-
-. Send the announcement email uploaded to the https://dist.apache.org/repos/dist/dev/logging/{project-name}[dist.apache.org/repos/dist/**dev**/logging/{project-name}] Subversion repository
-+
-[WARNING]
-====
-Make sure your email is sent in plain text, that is, https://infra.apache.org/contrib-email-tips#nohtml[no HTML]!
-If you are using GMail, simply enable the _"Plain text mode"_ while composing your message.
-====
diff --git a/src/changelog/.2.x.x/add-site.xml b/src/changelog/.2.x.x/add-site.xml
new file mode 100644
index 0000000..6307e85
--- /dev/null
+++ b/src/changelog/.2.x.x/add-site.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://logging.apache.org/log4j/changelog"
+ xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd"
+ type="added">
+ <description format="asciidoc">
+ Publish https://logging.apache.org/log4j/jmx-gui[the website]
+ </description>
+</entry>
diff --git a/src/site/_release-notes/_2.x.x.adoc b/src/site/_constants.adoc
similarity index 61%
copy from src/site/_release-notes/_2.x.x.adoc
copy to src/site/_constants.adoc
index 4b549ab..7743747 100644
--- a/src/site/_release-notes/_2.x.x.adoc
+++ b/src/site/_constants.adoc
@@ -6,7 +6,7 @@
(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
+ http://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,
@@ -22,35 +22,21 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
+ IF THIS FILE DOESN'T HAVE A `.tmpl.adoc` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`.
- Auto-generation happens during `generate-sources` phase of Maven.
+ `_constants.adoc` is auto-generated from `_constants.tmpl.adoc`.
+ Auto-generation happens during `process-sources` phase of Maven.
Hence, you must always
- 1. Find and edit the associated `.release-notes.adoc.ftl`
- 2. Run `./mvnw generate-sources`
- 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
+ 1. Edit `_constants.tmpl.adoc`
+ 2. Run `./mvnw process-sources`
+ 3. Commit both `_constants.tmpl.adoc` and the generated `_constants.adoc`
////
-[#release-notes-2-x-x]
-== 2.x.x
-
-
-
-This release contains minor improvements.
-
-
-=== Added
-
-* Started generating CycloneDX SBOM with the recent update of `logging-parent` to version `10.2.0`
-
-=== Changed
-
-* Add OSGi and JPMS descriptors
-* Update `logging-parent` to version `10.2.0`
-* Update `log4j-core` to version `2.21.0`
-
-=== Fixed
-
-* Restore the original Maven `groupId`: `org.apache.logging.log4j`
+:project-github-url: https://github.com/apache/logging-log4j-jmx-gui
+:project-version: 2.22.0-SNAPSHOT
+:project-name: Log4j JMX GUI
+:project-id: log4j-jmx-gui
+:java-target-version: 8
+:java-compiler-version: [17,18)
+:log4j-version: 2.21.0
diff --git a/src/site/_release-notes/_2.x.x.adoc b/src/site/_constants.tmpl.adoc
similarity index 61%
copy from src/site/_release-notes/_2.x.x.adoc
copy to src/site/_constants.tmpl.adoc
index 4b549ab..a46b732 100644
--- a/src/site/_release-notes/_2.x.x.adoc
+++ b/src/site/_constants.tmpl.adoc
@@ -6,7 +6,7 @@
(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
+ http://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,
@@ -22,35 +22,21 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
+ IF THIS FILE DOESN'T HAVE A `.tmpl.adoc` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`.
- Auto-generation happens during `generate-sources` phase of Maven.
+ `_constants.adoc` is auto-generated from `_constants.tmpl.adoc`.
+ Auto-generation happens during `process-sources` phase of Maven.
Hence, you must always
- 1. Find and edit the associated `.release-notes.adoc.ftl`
- 2. Run `./mvnw generate-sources`
- 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
+ 1. Edit `_constants.tmpl.adoc`
+ 2. Run `./mvnw process-sources`
+ 3. Commit both `_constants.tmpl.adoc` and the generated `_constants.adoc`
////
-[#release-notes-2-x-x]
-== 2.x.x
-
-
-
-This release contains minor improvements.
-
-
-=== Added
-
-* Started generating CycloneDX SBOM with the recent update of `logging-parent` to version `10.2.0`
-
-=== Changed
-
-* Add OSGi and JPMS descriptors
-* Update `logging-parent` to version `10.2.0`
-* Update `log4j-core` to version `2.21.0`
-
-=== Fixed
-
-* Restore the original Maven `groupId`: `org.apache.logging.log4j`
+:project-github-url: ${scm.url}
+:project-version: ${project.version}
+:project-name: Log4j JMX GUI
+:project-id: log4j-jmx-gui
+:java-target-version: ${maven.compiler.target}
+:java-compiler-version: ${minimalJavaBuildVersion}
+:log4j-version: ${log4j.version}
diff --git a/doc/manual.adoc b/src/site/_manual.adoc
similarity index 87%
rename from doc/manual.adoc
rename to src/site/_manual.adoc
index a015c30..e899194 100644
--- a/doc/manual.adoc
+++ b/src/site/_manual.adoc
@@ -1,32 +1,30 @@
////
-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.
+ 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
+
+ http://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.
////
-:project-version: 2.21.0
-:log4j-version: 2.20.0
:log4j-jmx-doc-url: https://logging.apache.org/log4j/2.x/manual/jmx.html
:oracle-remote-monitoring-doc-url: https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html#gdenl
+The Log4j JMX GUI provides a Swing-based client for remotely editing the Log4j configuration and remotely monitoring `StatusLogger` output.
+It can be run as a standalone application or as a JConsole plugin.
+
Log4j has built-in support for JMX.
The `StatusLogger`, `ContextSelector`, and all ``LoggerContext``s, ``LoggerConfig``s and ``Appender``s are instrumented with MBeans and can be remotely monitored and controlled.
See the {log4j-jmx-doc-url}[Log4j JMX support documentation] on how to configure it.
-The Log4j JMX GUI provides a Swing-based client for remotely editing the Log4j configuration and remotely monitoring `StatusLogger` output.
-It can be run as a standalone application or as a JConsole plugin.
-
[#jconsole-run]
== Running the client as a JConsole plugin
diff --git a/src/site/_release-notes/_2.x.x.adoc b/src/site/_release-notes/_2.x.x.adoc
index 4b549ab..1ee3429 100644
--- a/src/site/_release-notes/_2.x.x.adoc
+++ b/src/site/_release-notes/_2.x.x.adoc
@@ -44,6 +44,7 @@ This release contains minor improvements.
=== Added
* Started generating CycloneDX SBOM with the recent update of `logging-parent` to version `10.2.0`
+* Publish https://logging.apache.org/log4j/jmx-gui[the website]
=== Changed
diff --git a/src/site/index.adoc b/src/site/index.adoc
new file mode 100644
index 0000000..93e62d1
--- /dev/null
+++ b/src/site/index.adoc
@@ -0,0 +1,92 @@
+////
+ 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
+
+ http://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.
+////
+
+include::_constants.adoc[]
+
+= Log4j JMX GUI
+
+include::_manual.adoc[]
+
+[#development]
+== Development
+
+{project-name} uses {project-github-url}[GitHub] for source code management.
+
+The project requires a Java compiler matching the `{java-compiler-version}` range and targets Java `{java-target-version}`.
+
+You can build and verify sources using:
+
+[source,bash]
+----
+./mvnw verify
+----
+
+You can build and view the website as follows:
+
+[source,bash]
+----
+./mvnw -N site
+python -m http.server -d target/site
+----
+
+[#distribution]
+== Distribution
+
+In accordance with the Apache Software Foundation's release https://infra.apache.org/release-distribution.html[distribution policy] and https://infra.apache.org/release-publishing.html[creation process], project artifacts are _officially_ accessible from the following locations:
+
+* ASF https://repository.apache.org/content/repositories/releases[Release] and https://repository.apache.org/content/repositories/snapshots[snapshot] repositories (mirrored to https://central.sonatype.dev/[the Maven Central Repository])
+* ASF https://downloads.apache.org/logging/{project-id}[Distribution directory]
+
+See xref:#release-instructions[the release instructions] for details.
+
+[#cyclonedx-sbom]
+=== CycloneDX Software Bill of Materials (SBOM)
+
+Starting with version `0.6.0`, {project-name} distributes https://cyclonedx.org/capabilities/sbom/[CyclenoDX Software Bill of Materials (SBOM)] along with each deployed artifact.
+This is streamlined by `logging-parent`, see https://logging.apache.org/logging-parent/latest/#cyclonedx-sbom[its website] for details.
+
+[#support]
+== Support
+
+Please keep in mind that this project is intended for internal usage only.
+You can use GitHub Issues for feature requests and bug reports – not questions!
+See https://logging.apache.org/log4j/2.x/support.html[the Log4j support policy] for details.
+
+[#security]
+== Security
+
+If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:security@logging.apache.org[the Log4j security mailing list].
+See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details.
+
+include::_release-notes.adoc[]
+
+[#release-instructions]
+== Release instructions
+
+{project-name} employs the CI/CD foundation provided by the https://logging.apache.org/logging-parent[`logging-parent`].
+You can simply use its release instructions.
+
+[#license]
+== License
+
+Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
+See `NOTICE.txt` 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.
diff --git a/doc/jmx-jconsole-editconfig.png b/src/site/jmx-jconsole-editconfig.png
similarity index 100%
rename from doc/jmx-jconsole-editconfig.png
rename to src/site/jmx-jconsole-editconfig.png
diff --git a/doc/jmx-jconsole-statuslogger.png b/src/site/jmx-jconsole-statuslogger.png
similarity index 100%
rename from doc/jmx-jconsole-statuslogger.png
rename to src/site/jmx-jconsole-statuslogger.png
diff --git a/doc/jmx-standalone-editconfig.png b/src/site/jmx-standalone-editconfig.png
similarity index 100%
rename from doc/jmx-standalone-editconfig.png
rename to src/site/jmx-standalone-editconfig.png
diff --git a/doc/jmx-standalone-statuslogger.png b/src/site/jmx-standalone-statuslogger.png
similarity index 100%
rename from doc/jmx-standalone-statuslogger.png
rename to src/site/jmx-standalone-statuslogger.png