You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@logging.apache.org by "vy (via GitHub)" <gi...@apache.org> on 2024/04/04 13:06:28 UTC
[PR] Migrate `3.x` website to Antora (logging-log4j2)
vy opened a new pull request, #2443:
URL: https://github.com/apache/logging-log4j2/pull/2443
This work ports #2427 to `main`, i.e., Log4j 3.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Migrate `3.x` website to Antora (logging-log4j2)
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy merged PR #2443:
URL: https://github.com/apache/logging-log4j2/pull/2443
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Migrate `3.x` website to Antora (logging-log4j2)
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on code in PR #2443:
URL: https://github.com/apache/logging-log4j2/pull/2443#discussion_r1553169012
##########
src/site/resources/.htaccess:
##########
@@ -8,13 +7,16 @@
# "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
+# 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.
-# ----------------------------------------------------------------------------
-./mvnw spotless:apply -pl '!log4j-bom' -T2C
+#
+RewriteEngine On
+RewriteRule "^(/log4j/[23].x)/log4j-(core|api)/apidocs(.*)" "$1/javadoc/$2$3" [R=permanent]
+RewriteRule "^(/log4j/[23].x)/manual/scala-api.html" "/log4j/scala" [R=permanent]
+RewriteRule "^(/log4j/[23].x)/release-notes/index.html" "$1/release-notes.html" [R=permanent]
Review Comment:
> Remark that according to Git history we never had a `/log4j/3.x/log4j-api/apidocs/` folder.
Indeed, good catch.
I will remove it.
For the rest, [we agreed](https://the-asf.slack.com/archives/D0394M6GWTX/p1712304795414779) to keep the current simple version.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Migrate `3.x` website to Antora (logging-log4j2)
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on code in PR #2443:
URL: https://github.com/apache/logging-log4j2/pull/2443#discussion_r1553190265
##########
src/site/resources/.htaccess:
##########
@@ -1,5 +1,4 @@
-#!/bin/sh
-# ----------------------------------------------------------------------------
+#
Review Comment:
I will discuss this personally and apply @ppkarwasz's suggestion to both `2.x` and `main`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Migrate `3.x` website to Antora (logging-log4j2)
Posted by "ppkarwasz (via GitHub)" <gi...@apache.org>.
ppkarwasz commented on code in PR #2443:
URL: https://github.com/apache/logging-log4j2/pull/2443#discussion_r1551736197
##########
src/site/resources/.htaccess:
##########
@@ -8,13 +7,16 @@
# "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
+# 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.
-# ----------------------------------------------------------------------------
-./mvnw spotless:apply -pl '!log4j-bom' -T2C
+#
+RewriteEngine On
+RewriteRule "^(/log4j/[23].x)/log4j-(core|api)/apidocs(.*)" "$1/javadoc/$2$3" [R=permanent]
+RewriteRule "^(/log4j/[23].x)/manual/scala-api.html" "/log4j/scala" [R=permanent]
+RewriteRule "^(/log4j/[23].x)/release-notes/index.html" "$1/release-notes.html" [R=permanent]
Review Comment:
```suggestion
RewriteEngine On
RewriteBase "/log4j/3.x/"
RewriteRule "^manual/scala-api(\.html)?$" "/log4j/scala/" [R=permanent]
RewriteRule "^release-notes/(index(\.html)?)?$" "release-notes" [R=permanent]
```
This seems to work on my local server.
Remark that according to Git history we never had a `/log4j/3.x/log4j-api/apidocs/` folder.
It is also pretty much a personal taste, but I prefer to use URLs that do not end in `.html`. Redirects to folders on the other way must terminate in `/` to spare the client an additional redirection.
##########
src/site/resources/.htaccess:
##########
@@ -1,5 +1,4 @@
-#!/bin/sh
-# ----------------------------------------------------------------------------
+#
Review Comment:
_Nit_: this hidden file in a standalone folder is hard to find.
Could we have everything under the same tree? Also is `src/site/antora` the native location for Antora? If it is not, could we move it?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org