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/02/23 20:27:14 UTC
[logging-log4j2] 02/02: Redirect old `//apidocs` URLs to `/javadoc/` (#1284)
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit b1b687be624ca02149edd5c27c030db470dca7b0
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Thu Feb 23 21:28:46 2023 +0100
Redirect old `/<module>/apidocs` URLs to `/javadoc/<module>` (#1284)
---
.../.2.x.x/1284_redirect_old_javadoc_urls.xml | 26 +++++++++++++++++++++
src/site/markdown/javadoc.md | 5 ++--
.../log4j-api/apidocs/index.html} | 27 +++++++++++++---------
.../log4j-core/apidocs/index.html} | 27 +++++++++++++---------
4 files changed, 60 insertions(+), 25 deletions(-)
diff --git a/src/changelog/.2.x.x/1284_redirect_old_javadoc_urls.xml b/src/changelog/.2.x.x/1284_redirect_old_javadoc_urls.xml
new file mode 100644
index 0000000000..204bab6b69
--- /dev/null
+++ b/src/changelog/.2.x.x/1284_redirect_old_javadoc_urls.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<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.0.xsd"
+ type="fixed">
+ <issue id="1284" link="https://github.com/apache/logging-log4j2/pull/1284"/>
+ <author id="vy"/>
+ <author name="Alexander Brandes"/>
+ <description format="asciidoc"> <![CDATA[Redirect old `/<module>/apidocs` URLs (broken in 2.20.0) to `/javadoc/<module>`]]></description>
+</entry>
diff --git a/src/site/markdown/javadoc.md b/src/site/markdown/javadoc.md
index 4de2a12aee..439b5b4acc 100644
--- a/src/site/markdown/javadoc.md
+++ b/src/site/markdown/javadoc.md
@@ -18,10 +18,9 @@
# Javadoc API Documentation
-The table below contains links to the Javadoc API Documentation for the components you are most likely to use
-directly in code. You can also use the menu links on the left.
+The table below contains links to the Javadoc API Documentation for the components you are most likely to use directly in code.
Component | Description
--------- | -----------
-[Log4j 2 API](javadoc/log4j-api/index.html) | The interface that applications should use and code against.
+[API](javadoc/log4j-api/index.html) | The interface that applications should use and code against.
[Implementation](javadoc/log4j-core/index.html) | The standard implementation, also called the Log4j 2 Core, that contains Appenders, Filters, and more.
diff --git a/src/site/markdown/javadoc.md b/src/site/resources/log4j-api/apidocs/index.html
similarity index 55%
copy from src/site/markdown/javadoc.md
copy to src/site/resources/log4j-api/apidocs/index.html
index 4de2a12aee..4283511580 100644
--- a/src/site/markdown/javadoc.md
+++ b/src/site/resources/log4j-api/apidocs/index.html
@@ -1,4 +1,4 @@
-<!-- vim: set syn=markdown : -->
+<!DOCTYPE html>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,13 +15,18 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-# Javadoc API Documentation
-
-The table below contains links to the Javadoc API Documentation for the components you are most likely to use
-directly in code. You can also use the menu links on the left.
-
-Component | Description
---------- | -----------
-[Log4j 2 API](javadoc/log4j-api/index.html) | The interface that applications should use and code against.
-[Implementation](javadoc/log4j-core/index.html) | The standard implementation, also called the Log4j 2 Core, that contains Appenders, Filters, and more.
+<html lang="en">
+<head>
+ <title>Log4j API Javadoc</title>
+ <!-- Log4j 2.20.0 moved `/<module>/apidocs` to `/javadoc/<module>`.
+ This change broke many users' links to the old URL: https://github.com/apache/logging-log4j2/issues/1284
+ We have this HTML-based redirect here to continue support these old URLs. -->
+ <meta http-equiv="refresh" content="0; url='../../javadoc/log4j-api/index.html'"/>
+</head>
+<body>
+<p>
+ The page you requested has been relocated to <a href="../../javadoc/log4j-api/index.html">../../javadoc/log4j-api/index.html</a>.
+ You are getting redirected...
+</p>
+</body>
+</html>
diff --git a/src/site/markdown/javadoc.md b/src/site/resources/log4j-core/apidocs/index.html
similarity index 55%
copy from src/site/markdown/javadoc.md
copy to src/site/resources/log4j-core/apidocs/index.html
index 4de2a12aee..325ba57775 100644
--- a/src/site/markdown/javadoc.md
+++ b/src/site/resources/log4j-core/apidocs/index.html
@@ -1,4 +1,4 @@
-<!-- vim: set syn=markdown : -->
+<!DOCTYPE html>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,13 +15,18 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-# Javadoc API Documentation
-
-The table below contains links to the Javadoc API Documentation for the components you are most likely to use
-directly in code. You can also use the menu links on the left.
-
-Component | Description
---------- | -----------
-[Log4j 2 API](javadoc/log4j-api/index.html) | The interface that applications should use and code against.
-[Implementation](javadoc/log4j-core/index.html) | The standard implementation, also called the Log4j 2 Core, that contains Appenders, Filters, and more.
+<html lang="en">
+<head>
+ <title>Log4j Implementation Javadoc</title>
+ <!-- Log4j 2.20.0 moved `/<module>/apidocs` to `/javadoc/<module>`.
+ This change broke many users' links to the old URL: https://github.com/apache/logging-log4j2/issues/1284
+ We have this HTML-based redirect here to continue support these old URLs. -->
+ <meta http-equiv="refresh" content="0; url='../../javadoc/log4j-core/index.html'"/>
+</head>
+<body>
+<p>
+ The page you requested has been relocated to <a href="../../javadoc/log4j-core/index.html">../../javadoc/log4j-core/index.html</a>.
+ You are getting redirected...
+</p>
+</body>
+</html>