This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch 2.x-docgen-antora in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit ce38aa3e3a0d9bfdd3876c9d6c217f3d75dacba5 Author: Volkan Yazıcı <[email protected]> AuthorDate: Thu Mar 21 12:36:26 2024 +0100 WIP antora --- .gitignore | 4 ++ antora-playbook.yml | 42 +++++++++++ pom.xml | 83 +++++++++++++++++++--- src/site/antora/antora.tmpl.yml | 48 +++++++++++++ src/site/antora/antora.yml | 48 +++++++++++++ .../modules/ROOT/nav.adoc} | 7 +- .../modules/ROOT/pages}/_log4j1-eol.adoc | 0 .../modules/ROOT/pages}/articles.adoc | 0 .../modules/ROOT/pages}/components.adoc | 0 .../modules/ROOT/pages}/docs.adoc | 0 .../modules/ROOT/pages}/download.adoc | 0 .../modules/ROOT/pages}/faq.adoc | 0 .../modules/ROOT/pages}/guidelines.adoc | 0 .../modules/ROOT/pages}/index.adoc | 0 .../modules/ROOT/pages}/javadoc.adoc | 0 .../modules/ROOT/pages}/log4j-1.2-api.adoc | 0 .../modules/ROOT/pages}/log4j-api.adoc | 0 .../modules/ROOT/pages}/log4j-appserver.adoc | 0 .../modules/ROOT/pages}/log4j-cassandra.adoc | 0 .../modules/ROOT/pages}/log4j-couchdb.adoc | 0 .../modules/ROOT/pages}/log4j-docker.adoc | 0 .../modules/ROOT/pages}/log4j-flume-ng.adoc | 0 .../modules/ROOT/pages}/log4j-iostreams.adoc | 0 .../modules/ROOT/pages}/log4j-jakarta-web.adoc | 0 .../modules/ROOT/pages}/log4j-jcl.adoc | 0 .../modules/ROOT/pages}/log4j-jmx-gui.adoc | 0 .../modules/ROOT/pages}/log4j-jpl.adoc | 0 .../modules/ROOT/pages}/log4j-jul.adoc | 0 .../modules/ROOT/pages}/log4j-kubernetes.adoc | 0 .../modules/ROOT/pages}/log4j-mongodb3.adoc | 0 .../modules/ROOT/pages}/log4j-mongodb4.adoc | 0 .../modules/ROOT/pages}/log4j-slf4j-impl.adoc | 0 .../modules/ROOT/pages}/log4j-slf4j2-impl.adoc | 0 .../modules/ROOT/pages}/log4j-spring-boot.adoc | 0 .../pages}/log4j-spring-cloud-config-client.adoc | 0 .../ROOT/pages}/log4j-spring-cloud-config.adoc | 0 .../modules/ROOT/pages}/log4j-taglib.adoc | 0 .../modules/ROOT/pages}/log4j-to-jul.adoc | 0 .../modules/ROOT/pages}/log4j-to-slf4j.adoc | 0 .../modules/ROOT/pages}/log4j-web.adoc | 0 .../modules/ROOT/pages}/performance.adoc | 0 .../modules/ROOT/pages}/runtime-dependencies.adoc | 0 .../modules/ROOT/pages}/security.adoc | 0 .../modules/ROOT/pages}/support.adoc | 0 .../modules/ROOT/pages}/thanks.adoc | 0 .../modules/manual/pages}/api-separation.adoc | 0 .../modules/manual/pages}/api.adoc | 0 .../modules/manual/pages}/appenders.adoc | 0 .../modules/manual/pages}/architecture.adoc | 0 .../modules/manual/pages}/async.adoc | 0 .../modules/manual/pages}/cloud.adoc | 0 .../modules/manual/pages}/compatibility.adoc | 0 .../modules/manual/pages}/configuration.adoc | 0 .../modules/manual/pages}/customconfig.adoc | 0 .../modules/manual/pages}/customloglevels.adoc | 0 .../modules/manual/pages}/eventlogging.adoc | 0 .../modules/manual/pages}/extending.adoc | 0 .../modules/manual/pages}/filters.adoc | 0 .../modules/manual/pages}/flowtracing.adoc | 0 .../modules/manual/pages}/garbagefree.adoc | 0 .../modules/manual/pages}/index.adoc | 0 .../modules/manual/pages}/jmx.adoc | 0 .../manual/pages}/json-template-layout.adoc | 0 .../modules/manual/pages}/layouts.adoc | 0 .../modules/manual/pages}/logbuilder.adoc | 0 .../modules/manual/pages}/logsep.adoc | 0 .../modules/manual/pages}/lookups.adoc | 0 .../modules/manual/pages}/markers.adoc | 0 .../modules/manual/pages}/messages.adoc | 0 .../modules/manual/pages}/migration.adoc | 0 .../modules/manual/pages}/plugins.adoc | 0 .../modules/manual/pages}/thread-context.adoc | 0 .../modules/manual/pages}/usage.adoc | 0 .../modules/manual/pages}/webapp.adoc | 0 src/site/asciidoc/_constants.adoc | 41 ----------- src/site/asciidoc/_constants.tmpl.adoc | 40 ----------- 76 files changed, 220 insertions(+), 93 deletions(-) diff --git a/.gitignore b/.gitignore index 621511406a..5ac987cdea 100644 --- a/.gitignore +++ b/.gitignore @@ -35,3 +35,7 @@ velocity.log felix-cache/ /.metadata/ .DS_Store +node +node_modules +package.json +package-lock.json diff --git a/antora-playbook.yml b/antora-playbook.yml new file mode 100644 index 0000000000..bbc1a3802e --- /dev/null +++ b/antora-playbook.yml @@ -0,0 +1,42 @@ +# +# 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. +# +site: + title: Apache Log4j + url: "https://logging.apache.org/log4j/2.x"; + start_page: "home::index.adoc" +content: + sources: + - url: . + branches: HEAD + start_paths: + - target/generated-site/antora +ui: + bundle: + url: "https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable"; + snapshot: true + supplemental_files: + - path: partials/header-content.hbs + contents: | + <header class="header"> + <nav class="navbar"> + <div class="navbar-brand"> + <div class="navbar-item"> + <a href="{{ site.url }}">Apache Log4j</a> + </div> + </div> + </nav> + </header> diff --git a/pom.xml b/pom.xml index b67401c93c..68f1b8fc62 100644 --- a/pom.xml +++ b/pom.xml @@ -334,7 +334,14 @@ <maven.site.deploy.skip>true</maven.site.deploy.skip> <!-- Dependency versions --> + <antora.version>3.1.7</antora.version> <log4j-docgen.version>0.8.0-SNAPSHOT</log4j-docgen.version> + <node.version>21.7.1</node.version> + <npm.version>10.5.0</npm.version> + + <!-- Plugin versions --> + <exec-maven-plugin.version>3.2.0</exec-maven-plugin.version> + <frontend-maven-plugin.version>1.15.0</frontend-maven-plugin.version> <!-- ================================== `log4j-docgen`-specific properties @@ -670,7 +677,7 @@ </goals> <phase>pre-site</phase> <configuration> - <outputDirectory>${project.build.directory}/generated-site/asciidoc</outputDirectory> + <outputDirectory>${project.build.directory}/generated-site/antora/modules/ROOT/pages</outputDirectory> <indexTemplates> <template> <source>.index.adoc.ftl</source> @@ -694,16 +701,16 @@ <inherited>false</inherited> <executions> - <!-- Copy `src/site/asciidoc/_constants.tmpl.adoc` to `target/constants-adoc/_constants.adoc` --> + <!-- Copy `src/site/antora/antora.tmpl.yml` to `target/antora-yml/antora.yml` --> <execution> - <id>copy-constants-adoc</id> + <id>copy-antora-yml</id> <goals> <goal>run</goal> </goals> <phase>pre-site</phase> <configuration> <target> - <copy file="${project.basedir}/src/site/asciidoc/_constants.tmpl.adoc" tofile="${project.build.directory}/constants-adoc/_constants.adoc" overwrite="true"/> + <copy file="${project.basedir}/src/site/antora/antora.tmpl.yml" tofile="${project.build.directory}/antora-yml/antora.yml" overwrite="true"/> </target> </configuration> </execution> @@ -716,19 +723,19 @@ <artifactId>maven-resources-plugin</artifactId> <executions> - <!-- Process `target/constants-adoc` and output to `target/generated-site/asciidoc` --> + <!-- Process `target/antora-yml` and output to `target/generated-site/antora` --> <execution> - <id>filter-constants-adoc</id> + <id>filter-antora-yml</id> <goals> <goal>copy-resources</goal> </goals> <phase>pre-site</phase> <inherited>false</inherited> <configuration> - <outputDirectory>${project.build.directory}/generated-site/asciidoc</outputDirectory> + <outputDirectory>${project.build.directory}/generated-site/antora</outputDirectory> <resources> <resource> - <directory>${project.build.directory}/constants-adoc</directory> + <directory>${project.build.directory}/antora-yml</directory> <filtering>true</filtering> </resource> </resources> @@ -866,6 +873,65 @@ </plugin> + <plugin> + <groupId>com.github.eirslett</groupId> + <artifactId>frontend-maven-plugin</artifactId> + <version>${frontend-maven-plugin.version}</version> + <inherited>false</inherited> + <executions> + + <!-- Install Node & NPM --> + <execution> + <id>install-node-and-npm</id> + <goals> + <goal>install-node-and-npm</goal> + </goals> + <phase>pre-site</phase> + <configuration> + <nodeVersion>v${node.version}</nodeVersion> + <npmVersion>${npm.version}</npmVersion> + </configuration> + </execution> + + <!-- Install Antora --> + <execution> + <id>install-antora</id> + <goals> + <goal>npm</goal> + </goals> + <phase>pre-site</phase> + <configuration> + <arguments>install @antora/cli@${antora.version} @antora/site-generator-default@${antora.version}</arguments> + </configuration> + </execution> + + </executions> + </plugin> + + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>exec-maven-plugin</artifactId> + <version>${exec-maven-plugin.version}</version> + <executions> + <execution> + <id>run-antora</id> + <goals> + <goal>exec</goal> + </goals> + <phase>site</phase> + <inherited>false</inherited> + <configuration> + <executable>${project.basedir}/node/node</executable> + <arguments> + <argument>${project.basedir}/node_modules/.bin/antora</argument> + <argument>${project.basedir}/antora-playbook.yml</argument> + <argument>--to-dir=${project.build.directory}/antora-site</argument> + </arguments> + </configuration> + </execution> + </executions> + </plugin> + <plugin> <groupId>org.asciidoctor</groupId> @@ -906,6 +972,7 @@ </goals> <phase>site</phase> <configuration combine.self="override"> + <skip>true</skip> <resources> <resource> <directory>${project.build.directory}/generated-site/resources</directory> diff --git a/src/site/antora/antora.tmpl.yml b/src/site/antora/antora.tmpl.yml new file mode 100644 index 0000000000..9d16eb8bc7 --- /dev/null +++ b/src/site/antora/antora.tmpl.yml @@ -0,0 +1,48 @@ +# +# 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 FILE IS USED AS A TEMPLATE TO AUTO-GENERATE `antora.yml`! +# +# The actual `antora.yml` that is used in `target/generated-site/antora` is auto-generated from `antora.tmpl.yml`. +# Auto-generation happens during `pre-site` phase of Maven. +# Hence, you must always +# +# 1. Edit `antora.tmpl.yml` +# 2. Edit `antora.yml` to match the `antora.tmpl.yml` and fill Maven-injected attributes with dummy values +# + +name: "home" +title: "Home" +version: "~" +start_page: "index.adoc" +asciidoc: + attributes: + project-github-url: "${scm.url}" + project-version: "${project.version}" + project-name: "Log4j" + project-id: "log4j" + java-target-version: "${maven.compiler.target}" + java-compiler-version: "${minimalJavaBuildVersion}" +nav: + - "modules/ROOT/nav.adoc" diff --git a/src/site/antora/antora.yml b/src/site/antora/antora.yml new file mode 100644 index 0000000000..bf483052ad --- /dev/null +++ b/src/site/antora/antora.yml @@ -0,0 +1,48 @@ +# +# 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 FILE IS A STUB! +# +# The actual `antora.yml` that is used in `target/generated-site/antora` is auto-generated from `antora.tmpl.yml`. +# Auto-generation happens during `pre-site` phase of Maven. +# Hence, you must always +# +# 1. Edit `antora.tmpl.yml` +# 2. Edit `antora.yml` to match the `antora.tmpl.yml` and fill Maven-injected attributes with dummy values +# + +name: "home" +title: "Home" +version: "~" +start_page: "index.adoc" +asciidoc: + attributes: + project-github-url: "https://github.com/apache/logging-log4j2"; + project-version: "X.Y.Z" + project-name: "Log4j" + project-id: "log4j" + java-target-version: "8" + java-compiler-version: "[17,18)" +nav: + - "modules/ROOT/nav.adoc" diff --git a/src/site/asciidoc/log4j-spring-cloud-config.adoc b/src/site/antora/modules/ROOT/nav.adoc similarity index 85% copy from src/site/asciidoc/log4j-spring-cloud-config.adoc copy to src/site/antora/modules/ROOT/nav.adoc index 2fc047426f..4a89e2bb49 100644 --- a/src/site/asciidoc/log4j-spring-cloud-config.adoc +++ b/src/site/antora/modules/ROOT/nav.adoc @@ -1,7 +1,5 @@ -// vim: set syn=markdown : - //// -Licensed to the Apache Software Foundation (ASF) under one or more + 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 @@ -16,4 +14,5 @@ Licensed to the Apache Software Foundation (ASF) under one or more See the License for the specific language governing permissions and limitations under the License. //// -= Log4j Spring Cloud Config +* xref:index.adoc[] +* xref:support.adoc[] diff --git a/src/site/asciidoc/_log4j1-eol.adoc b/src/site/antora/modules/ROOT/pages/_log4j1-eol.adoc similarity index 100% rename from src/site/asciidoc/_log4j1-eol.adoc rename to src/site/antora/modules/ROOT/pages/_log4j1-eol.adoc diff --git a/src/site/asciidoc/articles.adoc b/src/site/antora/modules/ROOT/pages/articles.adoc similarity index 100% rename from src/site/asciidoc/articles.adoc rename to src/site/antora/modules/ROOT/pages/articles.adoc diff --git a/src/site/asciidoc/components.adoc b/src/site/antora/modules/ROOT/pages/components.adoc similarity index 100% rename from src/site/asciidoc/components.adoc rename to src/site/antora/modules/ROOT/pages/components.adoc diff --git a/src/site/asciidoc/docs.adoc b/src/site/antora/modules/ROOT/pages/docs.adoc similarity index 100% rename from src/site/asciidoc/docs.adoc rename to src/site/antora/modules/ROOT/pages/docs.adoc diff --git a/src/site/asciidoc/download.adoc b/src/site/antora/modules/ROOT/pages/download.adoc similarity index 100% rename from src/site/asciidoc/download.adoc rename to src/site/antora/modules/ROOT/pages/download.adoc diff --git a/src/site/asciidoc/faq.adoc b/src/site/antora/modules/ROOT/pages/faq.adoc similarity index 100% rename from src/site/asciidoc/faq.adoc rename to src/site/antora/modules/ROOT/pages/faq.adoc diff --git a/src/site/asciidoc/guidelines.adoc b/src/site/antora/modules/ROOT/pages/guidelines.adoc similarity index 100% rename from src/site/asciidoc/guidelines.adoc rename to src/site/antora/modules/ROOT/pages/guidelines.adoc diff --git a/src/site/asciidoc/index.adoc b/src/site/antora/modules/ROOT/pages/index.adoc similarity index 100% rename from src/site/asciidoc/index.adoc rename to src/site/antora/modules/ROOT/pages/index.adoc diff --git a/src/site/asciidoc/javadoc.adoc b/src/site/antora/modules/ROOT/pages/javadoc.adoc similarity index 100% rename from src/site/asciidoc/javadoc.adoc rename to src/site/antora/modules/ROOT/pages/javadoc.adoc diff --git a/src/site/asciidoc/log4j-1.2-api.adoc b/src/site/antora/modules/ROOT/pages/log4j-1.2-api.adoc similarity index 100% rename from src/site/asciidoc/log4j-1.2-api.adoc rename to src/site/antora/modules/ROOT/pages/log4j-1.2-api.adoc diff --git a/src/site/asciidoc/log4j-api.adoc b/src/site/antora/modules/ROOT/pages/log4j-api.adoc similarity index 100% rename from src/site/asciidoc/log4j-api.adoc rename to src/site/antora/modules/ROOT/pages/log4j-api.adoc diff --git a/src/site/asciidoc/log4j-appserver.adoc b/src/site/antora/modules/ROOT/pages/log4j-appserver.adoc similarity index 100% rename from src/site/asciidoc/log4j-appserver.adoc rename to src/site/antora/modules/ROOT/pages/log4j-appserver.adoc diff --git a/src/site/asciidoc/log4j-cassandra.adoc b/src/site/antora/modules/ROOT/pages/log4j-cassandra.adoc similarity index 100% rename from src/site/asciidoc/log4j-cassandra.adoc rename to src/site/antora/modules/ROOT/pages/log4j-cassandra.adoc diff --git a/src/site/asciidoc/log4j-couchdb.adoc b/src/site/antora/modules/ROOT/pages/log4j-couchdb.adoc similarity index 100% rename from src/site/asciidoc/log4j-couchdb.adoc rename to src/site/antora/modules/ROOT/pages/log4j-couchdb.adoc diff --git a/src/site/asciidoc/log4j-docker.adoc b/src/site/antora/modules/ROOT/pages/log4j-docker.adoc similarity index 100% rename from src/site/asciidoc/log4j-docker.adoc rename to src/site/antora/modules/ROOT/pages/log4j-docker.adoc diff --git a/src/site/asciidoc/log4j-flume-ng.adoc b/src/site/antora/modules/ROOT/pages/log4j-flume-ng.adoc similarity index 100% rename from src/site/asciidoc/log4j-flume-ng.adoc rename to src/site/antora/modules/ROOT/pages/log4j-flume-ng.adoc diff --git a/src/site/asciidoc/log4j-iostreams.adoc b/src/site/antora/modules/ROOT/pages/log4j-iostreams.adoc similarity index 100% rename from src/site/asciidoc/log4j-iostreams.adoc rename to src/site/antora/modules/ROOT/pages/log4j-iostreams.adoc diff --git a/src/site/asciidoc/log4j-jakarta-web.adoc b/src/site/antora/modules/ROOT/pages/log4j-jakarta-web.adoc similarity index 100% rename from src/site/asciidoc/log4j-jakarta-web.adoc rename to src/site/antora/modules/ROOT/pages/log4j-jakarta-web.adoc diff --git a/src/site/asciidoc/log4j-jcl.adoc b/src/site/antora/modules/ROOT/pages/log4j-jcl.adoc similarity index 100% rename from src/site/asciidoc/log4j-jcl.adoc rename to src/site/antora/modules/ROOT/pages/log4j-jcl.adoc diff --git a/src/site/asciidoc/log4j-jmx-gui.adoc b/src/site/antora/modules/ROOT/pages/log4j-jmx-gui.adoc similarity index 100% rename from src/site/asciidoc/log4j-jmx-gui.adoc rename to src/site/antora/modules/ROOT/pages/log4j-jmx-gui.adoc diff --git a/src/site/asciidoc/log4j-jpl.adoc b/src/site/antora/modules/ROOT/pages/log4j-jpl.adoc similarity index 100% rename from src/site/asciidoc/log4j-jpl.adoc rename to src/site/antora/modules/ROOT/pages/log4j-jpl.adoc diff --git a/src/site/asciidoc/log4j-jul.adoc b/src/site/antora/modules/ROOT/pages/log4j-jul.adoc similarity index 100% rename from src/site/asciidoc/log4j-jul.adoc rename to src/site/antora/modules/ROOT/pages/log4j-jul.adoc diff --git a/src/site/asciidoc/log4j-kubernetes.adoc b/src/site/antora/modules/ROOT/pages/log4j-kubernetes.adoc similarity index 100% rename from src/site/asciidoc/log4j-kubernetes.adoc rename to src/site/antora/modules/ROOT/pages/log4j-kubernetes.adoc diff --git a/src/site/asciidoc/log4j-mongodb3.adoc b/src/site/antora/modules/ROOT/pages/log4j-mongodb3.adoc similarity index 100% rename from src/site/asciidoc/log4j-mongodb3.adoc rename to src/site/antora/modules/ROOT/pages/log4j-mongodb3.adoc diff --git a/src/site/asciidoc/log4j-mongodb4.adoc b/src/site/antora/modules/ROOT/pages/log4j-mongodb4.adoc similarity index 100% rename from src/site/asciidoc/log4j-mongodb4.adoc rename to src/site/antora/modules/ROOT/pages/log4j-mongodb4.adoc diff --git a/src/site/asciidoc/log4j-slf4j-impl.adoc b/src/site/antora/modules/ROOT/pages/log4j-slf4j-impl.adoc similarity index 100% rename from src/site/asciidoc/log4j-slf4j-impl.adoc rename to src/site/antora/modules/ROOT/pages/log4j-slf4j-impl.adoc diff --git a/src/site/asciidoc/log4j-slf4j2-impl.adoc b/src/site/antora/modules/ROOT/pages/log4j-slf4j2-impl.adoc similarity index 100% rename from src/site/asciidoc/log4j-slf4j2-impl.adoc rename to src/site/antora/modules/ROOT/pages/log4j-slf4j2-impl.adoc diff --git a/src/site/asciidoc/log4j-spring-boot.adoc b/src/site/antora/modules/ROOT/pages/log4j-spring-boot.adoc similarity index 100% rename from src/site/asciidoc/log4j-spring-boot.adoc rename to src/site/antora/modules/ROOT/pages/log4j-spring-boot.adoc diff --git a/src/site/asciidoc/log4j-spring-cloud-config-client.adoc b/src/site/antora/modules/ROOT/pages/log4j-spring-cloud-config-client.adoc similarity index 100% rename from src/site/asciidoc/log4j-spring-cloud-config-client.adoc rename to src/site/antora/modules/ROOT/pages/log4j-spring-cloud-config-client.adoc diff --git a/src/site/asciidoc/log4j-spring-cloud-config.adoc b/src/site/antora/modules/ROOT/pages/log4j-spring-cloud-config.adoc similarity index 100% rename from src/site/asciidoc/log4j-spring-cloud-config.adoc rename to src/site/antora/modules/ROOT/pages/log4j-spring-cloud-config.adoc diff --git a/src/site/asciidoc/log4j-taglib.adoc b/src/site/antora/modules/ROOT/pages/log4j-taglib.adoc similarity index 100% rename from src/site/asciidoc/log4j-taglib.adoc rename to src/site/antora/modules/ROOT/pages/log4j-taglib.adoc diff --git a/src/site/asciidoc/log4j-to-jul.adoc b/src/site/antora/modules/ROOT/pages/log4j-to-jul.adoc similarity index 100% rename from src/site/asciidoc/log4j-to-jul.adoc rename to src/site/antora/modules/ROOT/pages/log4j-to-jul.adoc diff --git a/src/site/asciidoc/log4j-to-slf4j.adoc b/src/site/antora/modules/ROOT/pages/log4j-to-slf4j.adoc similarity index 100% rename from src/site/asciidoc/log4j-to-slf4j.adoc rename to src/site/antora/modules/ROOT/pages/log4j-to-slf4j.adoc diff --git a/src/site/asciidoc/log4j-web.adoc b/src/site/antora/modules/ROOT/pages/log4j-web.adoc similarity index 100% rename from src/site/asciidoc/log4j-web.adoc rename to src/site/antora/modules/ROOT/pages/log4j-web.adoc diff --git a/src/site/asciidoc/performance.adoc b/src/site/antora/modules/ROOT/pages/performance.adoc similarity index 100% rename from src/site/asciidoc/performance.adoc rename to src/site/antora/modules/ROOT/pages/performance.adoc diff --git a/src/site/asciidoc/runtime-dependencies.adoc b/src/site/antora/modules/ROOT/pages/runtime-dependencies.adoc similarity index 100% rename from src/site/asciidoc/runtime-dependencies.adoc rename to src/site/antora/modules/ROOT/pages/runtime-dependencies.adoc diff --git a/src/site/asciidoc/security.adoc b/src/site/antora/modules/ROOT/pages/security.adoc similarity index 100% rename from src/site/asciidoc/security.adoc rename to src/site/antora/modules/ROOT/pages/security.adoc diff --git a/src/site/asciidoc/support.adoc b/src/site/antora/modules/ROOT/pages/support.adoc similarity index 100% rename from src/site/asciidoc/support.adoc rename to src/site/antora/modules/ROOT/pages/support.adoc diff --git a/src/site/asciidoc/thanks.adoc b/src/site/antora/modules/ROOT/pages/thanks.adoc similarity index 100% rename from src/site/asciidoc/thanks.adoc rename to src/site/antora/modules/ROOT/pages/thanks.adoc diff --git a/src/site/asciidoc/manual/api-separation.adoc b/src/site/antora/modules/manual/pages/api-separation.adoc similarity index 100% rename from src/site/asciidoc/manual/api-separation.adoc rename to src/site/antora/modules/manual/pages/api-separation.adoc diff --git a/src/site/asciidoc/manual/api.adoc b/src/site/antora/modules/manual/pages/api.adoc similarity index 100% rename from src/site/asciidoc/manual/api.adoc rename to src/site/antora/modules/manual/pages/api.adoc diff --git a/src/site/asciidoc/manual/appenders.adoc b/src/site/antora/modules/manual/pages/appenders.adoc similarity index 100% rename from src/site/asciidoc/manual/appenders.adoc rename to src/site/antora/modules/manual/pages/appenders.adoc diff --git a/src/site/asciidoc/manual/architecture.adoc b/src/site/antora/modules/manual/pages/architecture.adoc similarity index 100% rename from src/site/asciidoc/manual/architecture.adoc rename to src/site/antora/modules/manual/pages/architecture.adoc diff --git a/src/site/asciidoc/manual/async.adoc b/src/site/antora/modules/manual/pages/async.adoc similarity index 100% rename from src/site/asciidoc/manual/async.adoc rename to src/site/antora/modules/manual/pages/async.adoc diff --git a/src/site/asciidoc/manual/cloud.adoc b/src/site/antora/modules/manual/pages/cloud.adoc similarity index 100% rename from src/site/asciidoc/manual/cloud.adoc rename to src/site/antora/modules/manual/pages/cloud.adoc diff --git a/src/site/asciidoc/manual/compatibility.adoc b/src/site/antora/modules/manual/pages/compatibility.adoc similarity index 100% rename from src/site/asciidoc/manual/compatibility.adoc rename to src/site/antora/modules/manual/pages/compatibility.adoc diff --git a/src/site/asciidoc/manual/configuration.adoc b/src/site/antora/modules/manual/pages/configuration.adoc similarity index 100% rename from src/site/asciidoc/manual/configuration.adoc rename to src/site/antora/modules/manual/pages/configuration.adoc diff --git a/src/site/asciidoc/manual/customconfig.adoc b/src/site/antora/modules/manual/pages/customconfig.adoc similarity index 100% rename from src/site/asciidoc/manual/customconfig.adoc rename to src/site/antora/modules/manual/pages/customconfig.adoc diff --git a/src/site/asciidoc/manual/customloglevels.adoc b/src/site/antora/modules/manual/pages/customloglevels.adoc similarity index 100% rename from src/site/asciidoc/manual/customloglevels.adoc rename to src/site/antora/modules/manual/pages/customloglevels.adoc diff --git a/src/site/asciidoc/manual/eventlogging.adoc b/src/site/antora/modules/manual/pages/eventlogging.adoc similarity index 100% rename from src/site/asciidoc/manual/eventlogging.adoc rename to src/site/antora/modules/manual/pages/eventlogging.adoc diff --git a/src/site/asciidoc/manual/extending.adoc b/src/site/antora/modules/manual/pages/extending.adoc similarity index 100% rename from src/site/asciidoc/manual/extending.adoc rename to src/site/antora/modules/manual/pages/extending.adoc diff --git a/src/site/asciidoc/manual/filters.adoc b/src/site/antora/modules/manual/pages/filters.adoc similarity index 100% rename from src/site/asciidoc/manual/filters.adoc rename to src/site/antora/modules/manual/pages/filters.adoc diff --git a/src/site/asciidoc/manual/flowtracing.adoc b/src/site/antora/modules/manual/pages/flowtracing.adoc similarity index 100% rename from src/site/asciidoc/manual/flowtracing.adoc rename to src/site/antora/modules/manual/pages/flowtracing.adoc diff --git a/src/site/asciidoc/manual/garbagefree.adoc b/src/site/antora/modules/manual/pages/garbagefree.adoc similarity index 100% rename from src/site/asciidoc/manual/garbagefree.adoc rename to src/site/antora/modules/manual/pages/garbagefree.adoc diff --git a/src/site/asciidoc/manual/index.adoc b/src/site/antora/modules/manual/pages/index.adoc similarity index 100% rename from src/site/asciidoc/manual/index.adoc rename to src/site/antora/modules/manual/pages/index.adoc diff --git a/src/site/asciidoc/manual/jmx.adoc b/src/site/antora/modules/manual/pages/jmx.adoc similarity index 100% rename from src/site/asciidoc/manual/jmx.adoc rename to src/site/antora/modules/manual/pages/jmx.adoc diff --git a/src/site/asciidoc/manual/json-template-layout.adoc b/src/site/antora/modules/manual/pages/json-template-layout.adoc similarity index 100% rename from src/site/asciidoc/manual/json-template-layout.adoc rename to src/site/antora/modules/manual/pages/json-template-layout.adoc diff --git a/src/site/asciidoc/manual/layouts.adoc b/src/site/antora/modules/manual/pages/layouts.adoc similarity index 100% rename from src/site/asciidoc/manual/layouts.adoc rename to src/site/antora/modules/manual/pages/layouts.adoc diff --git a/src/site/asciidoc/manual/logbuilder.adoc b/src/site/antora/modules/manual/pages/logbuilder.adoc similarity index 100% rename from src/site/asciidoc/manual/logbuilder.adoc rename to src/site/antora/modules/manual/pages/logbuilder.adoc diff --git a/src/site/asciidoc/manual/logsep.adoc b/src/site/antora/modules/manual/pages/logsep.adoc similarity index 100% rename from src/site/asciidoc/manual/logsep.adoc rename to src/site/antora/modules/manual/pages/logsep.adoc diff --git a/src/site/asciidoc/manual/lookups.adoc b/src/site/antora/modules/manual/pages/lookups.adoc similarity index 100% rename from src/site/asciidoc/manual/lookups.adoc rename to src/site/antora/modules/manual/pages/lookups.adoc diff --git a/src/site/asciidoc/manual/markers.adoc b/src/site/antora/modules/manual/pages/markers.adoc similarity index 100% rename from src/site/asciidoc/manual/markers.adoc rename to src/site/antora/modules/manual/pages/markers.adoc diff --git a/src/site/asciidoc/manual/messages.adoc b/src/site/antora/modules/manual/pages/messages.adoc similarity index 100% rename from src/site/asciidoc/manual/messages.adoc rename to src/site/antora/modules/manual/pages/messages.adoc diff --git a/src/site/asciidoc/manual/migration.adoc b/src/site/antora/modules/manual/pages/migration.adoc similarity index 100% rename from src/site/asciidoc/manual/migration.adoc rename to src/site/antora/modules/manual/pages/migration.adoc diff --git a/src/site/asciidoc/manual/plugins.adoc b/src/site/antora/modules/manual/pages/plugins.adoc similarity index 100% rename from src/site/asciidoc/manual/plugins.adoc rename to src/site/antora/modules/manual/pages/plugins.adoc diff --git a/src/site/asciidoc/manual/thread-context.adoc b/src/site/antora/modules/manual/pages/thread-context.adoc similarity index 100% rename from src/site/asciidoc/manual/thread-context.adoc rename to src/site/antora/modules/manual/pages/thread-context.adoc diff --git a/src/site/asciidoc/manual/usage.adoc b/src/site/antora/modules/manual/pages/usage.adoc similarity index 100% rename from src/site/asciidoc/manual/usage.adoc rename to src/site/antora/modules/manual/pages/usage.adoc diff --git a/src/site/asciidoc/manual/webapp.adoc b/src/site/antora/modules/manual/pages/webapp.adoc similarity index 100% rename from src/site/asciidoc/manual/webapp.adoc rename to src/site/antora/modules/manual/pages/webapp.adoc diff --git a/src/site/asciidoc/_constants.adoc b/src/site/asciidoc/_constants.adoc deleted file mode 100644 index c132bb1ce9..0000000000 --- a/src/site/asciidoc/_constants.adoc +++ /dev/null @@ -1,41 +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 FILE IS A STUB! - THE ACTUAL CONTENT WILL BE AUTO-GENERATED! - - The actual `_constants.adoc` that is used in `target/generated-site/asciidoc` is auto-generated from `_constants.tmpl.adoc`. - Auto-generation happens during `pre-site` phase of Maven. - Hence, you must always - - 1. Edit `_constants.tmpl.adoc` - 2. Fill `_constants.adoc` with dummy values to match the variables in `_constants.tmpl.adoc` -//// - -:project-github-url: https://github.com/apache/logging-log4j2 -:project-version: X.Y.Z -:project-name: Log4j -:project-id: log4j -:java-target-version: 8 -:java-compiler-version: [17,18) diff --git a/src/site/asciidoc/_constants.tmpl.adoc b/src/site/asciidoc/_constants.tmpl.adoc deleted file mode 100644 index c3cc775daa..0000000000 --- a/src/site/asciidoc/_constants.tmpl.adoc +++ /dev/null @@ -1,40 +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 FILE IS USED AS A TEMPLATE TO AUTO-GENERATE `_constants.adoc`! - - The actual `_constants.adoc` that is used in `target/generated-site/asciidoc` is auto-generated from `_constants.tmpl.adoc`. - Auto-generation happens during `pre-site` phase of Maven. - Hence, you must always - - 1. Edit `_constants.tmpl.adoc` - 2. Fill `_constants.adoc` with dummy values to match the variables in `_constants.tmpl.adoc` -//// - -:project-github-url: ${scm.url} -:project-version: ${project.version} -:project-name: Log4j -:project-id: log4j -:java-target-version: ${maven.compiler.target} -:java-compiler-version: ${minimalJavaBuildVersion}
