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 2025/08/26 09:13:18 UTC
[PR] Migrate project to Antora [logging-site]
vy opened a new pull request, #14:
URL: https://github.com/apache/logging-site/pull/14
This PR migrates the project to Antora, and provides following benefits:
* Improves navigation issues (lack of ToC, permalink, etc.)
* Addresses UI issues reported in #9
* Uses the same mechanism shared by Logging Parent, Log4Net, Log4j, Log4j Kotlin, Log4j Scala, Log4j Tools, Log4j Transform, etc.
--
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 project to Antora [logging-site]
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on PR #14:
URL: https://github.com/apache/logging-site/pull/14#issuecomment-3699147935
> 2. **Static files (DOAP, VDR, XSD)**
> These are machine-consumed entry points and their URLs **should** remain stable and canonical (e.g. `https://logging.apache.org/cyclonedx/vdr.xml`). Using Antora attachments changes/obscures those URLs, so I don’t think attachments are the right fit here.
> Using [**UI supplemental static files**](https://docs.antora.org/antora/latest/playbook/ui-supplemental-files/#static-files) seems more appropriate.
I had already considered the UI supplemental files route, but refrained from it due to two major drawbacks:
1. You need to explicitly provide every single file in `antora-playbook.yaml > ui.supplemental_files` object
2. You need to change [the UI output directory](https://docs.antora.org/antora/latest/playbook/ui-output-dir/) — I find this a disruptive change (we deviate from Antora defaults) for a very small issue
Nevertheless, I implemented this in 6d30d6e9. Though later on, in e9f718b2, I switched to `maven-resources-plugin` to copy static content, and this doesn't suffer from the aforementioned shortcomings.
> 3. **Blog not in navigation**
> The blog is currently missing from the nav. We should either add a `blog/index.adoc` page or include the existing blog entries in the navigation.
Fixed in bc1f7c68.
--
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 project to Antora [logging-site]
Posted by "ppkarwasz (via GitHub)" <gi...@apache.org>.
ppkarwasz commented on code in PR #14:
URL: https://github.com/apache/logging-site/pull/14#discussion_r2651799323
##########
src/site/antora/modules/ROOT/nav.adoc:
##########
@@ -0,0 +1,29 @@
+////
+ 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.
+////
+
+* About
+** xref:guidelines.adoc[]
+** xref:charter.adoc[]
+** xref:team-list.adoc[]
+** xref:processes.adoc[]
+** https://cwiki.apache.org/confluence/display/LOGGING/Home[Wiki]
+** xref:what-is-logging.adoc[]
+
+* xref:download.adoc[]
+* xref:support.adoc[]
+* xref:security.adoc[]
+* xref:xml/ns/index.adoc[XML Schema]
Review Comment:
Some links are missing to comply with the [Apache Project Branding Policy](https://www.apache.org/foundation/marks/pmcs#navigation):
```suggestion
* xref:xml/ns/index.adoc[XML Schema]
* https://apache.org[The ASF]
** https://apache.org/licenses/[License]
** https://apache.org/foundation/sponsorship[Donate]
** https://apache.org/foundation/sponsors[Thanks]
```
Whimsy checks do not enforce the `www.` prefix nor the `.html` suffix, so I propose to omit them, since they are pretty much redundant.
--
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 project to Antora [logging-site]
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy merged PR #14:
URL: https://github.com/apache/logging-site/pull/14
--
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 project to Antora [logging-site]
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on code in PR #14:
URL: https://github.com/apache/logging-site/pull/14#discussion_r2652859506
##########
src/site/antora/modules/ROOT/nav.adoc:
##########
@@ -0,0 +1,29 @@
+////
+ 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.
+////
+
+* About
+** xref:guidelines.adoc[]
+** xref:charter.adoc[]
+** xref:team-list.adoc[]
+** xref:processes.adoc[]
+** https://cwiki.apache.org/confluence/display/LOGGING/Home[Wiki]
+** xref:what-is-logging.adoc[]
+
+* xref:download.adoc[]
+* xref:support.adoc[]
+* xref:security.adoc[]
+* xref:xml/ns/index.adoc[XML Schema]
Review Comment:
Fixed in 79627b35.
--
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 project to Antora [logging-site]
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on PR #14:
URL: https://github.com/apache/logging-site/pull/14#issuecomment-3699149890
Note that [Activity Monitor](https://logging.apache.org/activity-monitor/) links are removed. I am intending to nuke it in a subsequent PR.
--
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 project to Antora [logging-site]
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on PR #14:
URL: https://github.com/apache/logging-site/pull/14#issuecomment-3223322621
@ppkarwasz, I'd appreciate your review, and also suggestions on serving assets, which is _complicated_ in Antora. `cyclonedx/vdr.xml`, `doaps/doap_Log4j.rdf`, `xml/ns/*.xsd` files are moved to `/_attachments`. We can use a `.htaccess` or create symlinks in `pom.xml`, etc. What would you suggest?
--
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