You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Bukama (via GitHub)" <gi...@apache.org> on 2024/12/29 16:39:01 UTC
[PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Bukama opened a new pull request, #614:
URL: https://github.com/apache/maven-site/pull/614
With this PR I updated some very old (, but still existing) pages to reduce the renderer warnings during the `site` goal (see MNGSITE-504).
This PR is **not* to update the outdated content of those pages!
I could fix all warnings in the existing files, except the following four:
```
[WARNING] Unrecognized xdoc tag <base> at [32:52]
[WARNING] Unrecognized xdoc tag <link> at [34:100]
[WARNING] Unrecognized xdoc tag <link> at [35:75]
[WARNING] Unrecognized xdoc tag <link> at [36:90]
```
These are from CSS definition in the `errors/404.xml.vm`. I couldn't find a documentation how to define them properly, esp. as we need dynamic links. This why I transformed the page to a markdown file.
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "Bukama (via GitHub)" <gi...@apache.org>.
Bukama commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1900387361
##########
content/xdoc/errors/404.xml.vm:
##########
Review Comment:
> In general every valid HTML is also valid in MD (https://daringfireball.net/projects/markdown/syntax#html). This is more a question on how the resulting HTML is being partitioned by the doxia-sitetools (to inject things like navigation).
Thank you for your response. For the moment I reverted the changes in the 404 (meaning the `vm` is back there and the `md` is gone), until we are sure. To change the 404 to MD is done in few mins anyway.
But this means that the rendering warnings, caused by this page (double title and the HTTP `Unrecognized xdoc tag` are back in place)
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "Bukama (via GitHub)" <gi...@apache.org>.
Bukama commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899365421
##########
content/xdoc/errors/404.xml.vm:
##########
Review Comment:
Okay, will wait for an answer of @kwin or @michael-o about your question and then change or revert the 404 file
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "slawekjaranowski (via GitHub)" <gi...@apache.org>.
slawekjaranowski commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899194852
##########
content/xdoc/errors/404.xml.vm:
##########
Review Comment:
The problem will be on page like: https://maven.apache.org/plugins/maven-abc-plugin/
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899197068
##########
content/markdown/errors/404.md:
##########
@@ -0,0 +1,29 @@
+<!--
Review Comment:
My bad. I forgot about inline HTML. This is OK synatctically
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899175911
##########
content/markdown/errors/404.md:
##########
@@ -0,0 +1,29 @@
+<!--
Review Comment:
I don't think markdown supports comments?
##########
content/markdown/errors/404.md:
##########
@@ -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.
+-->
+
+# Page Not Found
+
+We're sorry, but the page you requested cannot be found. This may be because:
+
Review Comment:
need periods
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "slachiewicz (via GitHub)" <gi...@apache.org>.
slachiewicz merged PR #614:
URL: https://github.com/apache/maven-site/pull/614
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "kwin (via GitHub)" <gi...@apache.org>.
kwin commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1900385042
##########
content/xdoc/errors/404.xml.vm:
##########
Review Comment:
In general every valid HTML is also valid in MD (https://daringfireball.net/projects/markdown/syntax#html). This is more a question on how the resulting HTML is being partitioned by the doxia-sitetools (to inject things like navigation).
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "Bukama (via GitHub)" <gi...@apache.org>.
Bukama commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899182501
##########
content/xdoc/errors/404.xml.vm:
##########
Review Comment:
> We can not move it to `md` We need additional html page headers.
>
> This content can be displayed in any path .... and without those header content will be corrupted.
>
> @kwin @michael-o can we add html headers in `md` format?
To add as an information what I've tested locally:
I checked the `.htaccess` which redirects to this in case of 404 and I checked if `/errors/404.html` is displayed correctly - which it is.
But I'm honest: I'm not very experienced with `.htaccess` file (as you probably already noticed).
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "michael-o (via GitHub)" <gi...@apache.org>.
michael-o commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899196305
##########
content/markdown/errors/404.md:
##########
@@ -0,0 +1,29 @@
+<!--
Review Comment:
No, that is a bug @kwin had ready fixed.on master.
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "slawekjaranowski (via GitHub)" <gi...@apache.org>.
slawekjaranowski commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899178078
##########
content/xdoc/errors/404.xml.vm:
##########
Review Comment:
We can not move it to `md`
We need additional html page headers.
This content can be displayed in any path .... and without those header content will be corrupted.
@kwin @michael-o can we add html headers in `md` format?
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899192970
##########
content/markdown/errors/404.md:
##########
@@ -0,0 +1,29 @@
+<!--
Review Comment:
I think that's a function of some particular implementation that extends the spec. I'm not sure we can/should rely on that.
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "Bukama (via GitHub)" <gi...@apache.org>.
Bukama commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1900425802
##########
content/xdoc/errors/404.xml.vm:
##########
Review Comment:
Side note: Did some tests about using test and filed an issue [DOXIASITETOOLS-358](https://issues.apache.org/jira/browse/DOXIASITETOOLS-358)
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "Bukama (via GitHub)" <gi...@apache.org>.
Bukama commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899194534
##########
content/markdown/errors/404.md:
##########
@@ -0,0 +1,29 @@
+<!--
Review Comment:
> I think that's a function of some particular implementation that extends the spec. I'm not sure we can/should rely on that.
Then we need to change **all** other `.md` files too and remove every comments and licences there...
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "Bukama (via GitHub)" <gi...@apache.org>.
Bukama commented on PR #614:
URL: https://github.com/apache/maven-site/pull/614#issuecomment-2571354571
Rebased after several other commits were merged into master
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MNGSITE-504] Fix rendering / markdown warnings [maven-site]
Posted by "Bukama (via GitHub)" <gi...@apache.org>.
Bukama commented on code in PR #614:
URL: https://github.com/apache/maven-site/pull/614#discussion_r1899183058
##########
content/markdown/errors/404.md:
##########
@@ -0,0 +1,29 @@
+<!--
Review Comment:
> I don't think markdown supports comments?
Works fine:
--
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: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org