maven-site icon indicating copy to clipboard operation
maven-site copied to clipboard

Bump Maven Site Plugin AND Maven Fluido Skin

Open michael-o opened this issue 1 year ago โ€ข 18 comments

Both need to be updated in tandem to get proper rendering results.

Addresses one of the issues from https://the-asf.slack.com/archives/C7Q9JB404/p1715479275966359

michael-o avatar May 12 '24 10:05 michael-o

We should check it ... by other hands My test:

  • What is Maven?, Maven Extensions - is empty - markdown problems?
  • Release Notes - is almost empty - looks like macros not working

I not checked all pages ๐Ÿ˜„

slawekjaranowski avatar May 12 '24 10:05 slawekjaranowski

We should check it ... by other hands My test:

* `What is Maven?`, `Maven Extensions` - is empty - markdown problems?

* `Release Notes` - is almost empty - looks like macros not working

I not checked all pages ๐Ÿ˜„

It is broken, the parsers are strict now for sections:

D:\Entwicklung\Projekte\maven-site [bump-site-and-fluido-version โ‰ก +0 ~2 -0 !]> git diff content/markdown/what-is-maven.md
diff --git a/content/markdown/what-is-maven.md b/content/markdown/what-is-maven.md
index 9a8f73d4..bb848972 100644
--- a/content/markdown/what-is-maven.md
+++ b/content/markdown/what-is-maven.md
@@ -1,4 +1,4 @@
-## Introduction
+# Introduction
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file

michael-o avatar May 12 '24 11:05 michael-o

We should check it ... by other hands My test:

* `What is Maven?`, `Maven Extensions` - is empty - markdown problems?

* `Release Notes` - is almost empty - looks like macros not working

I not checked all pages ๐Ÿ˜„

Which release notes are empty?

michael-o avatar May 12 '24 11:05 michael-o

@slawekjaranowski This should fix it. The Markdown files were logically incorrect.

michael-o avatar May 12 '24 12:05 michael-o

release history: image

slawekjaranowski avatar May 12 '24 13:05 slawekjaranowski

It is broken, the parsers are strict now for sections:

So the build should fail when page is not generated at all due to error.

slawekjaranowski avatar May 12 '24 13:05 slawekjaranowski

alignment also changed: image

slawekjaranowski avatar May 12 '24 13:05 slawekjaranowski

It is broken, the parsers are strict now for sections:

So the build should fail when page is not generated at all due to error.

@kwin, WDYT?

michael-o avatar May 12 '24 19:05 michael-o

alignment also changed: image

Comes from https://issues.apache.org/jira/browse/MSKINS-230. We need to decide whether we want to keep it it have bootstrap style enforced.

michael-o avatar May 12 '24 19:05 michael-o

release history: image

Done.

michael-o avatar May 12 '24 19:05 michael-o

It is broken, the parsers are strict now for sections:

So the build should fail when page is not generated at all due to error.

From the top of my head I have no idea because this is now only with Markdown and most of the parsing is done with Flexmark anyway. But some of the strictness has been added by @kwin recently. The purpose is that the output should be parseable again from a Doxia point of view. Broken output cannot be parsed :-(

michael-o avatar May 12 '24 19:05 michael-o

I have not deliberately changed anything about being more strict with section nesting, I think we should still allow starting with an h2. Could be an unintended side effect of fixing the nesting levels. Do we have a minimum example in MD? Any warning emitted?

kwin avatar May 12 '24 19:05 kwin

I have not deliberately changed anything about being more strict with section nesting, I think we should still allow starting with an h2. Could be an unintended side effect of fixing the nesting levels. Do we have a minimum example in MD? Any warning emitted?

There is no warning, just no output.

michael-o avatar May 13 '24 08:05 michael-o

I have found another severe bug I need to report: As soon as auto anchors are enabled title for the document is not extracted/filled, if you do this then it works again:

diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
index 544b6b9..b6a7d1d 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
@@ -330,7 +330,6 @@ public class DefaultSiteRenderer implements Renderer {
             if (!isConfigured) {
                 // DOXIASITETOOLS-146 don't render comments from source markup
                 parser.setEmitComments(false);
-                parser.setEmitAnchorsForIndexableEntries(true);
             }

             // TODO: DOXIA-111: the filter used here must be checked generally.

michael-o avatar May 13 '24 08:05 michael-o

Here it is https://issues.apache.org/jira/browse/DOXIASITETOOLS-339

michael-o avatar May 13 '24 08:05 michael-o

I will hold off new releases until this issues is resolved.

michael-o avatar May 13 '24 08:05 michael-o

I have not deliberately changed anything about being more strict with section nesting, I think we should still allow starting with an h2. Could be an unintended side effect of fixing the nesting levels. Do we have a minimum example in MD? Any warning emitted?

Minimal MD without any output and broken HTML:

## Introduction

Foo

output:

        <main id="bodyColumn" class="span10">
<section>
        </main>

michael-o avatar May 13 '24 08:05 michael-o

I will factor out the document fixes first...

michael-o avatar May 13 '24 08:05 michael-o

I think it is time for an update again. @michael-o Do you take it up or should I take over to bump to latest m-site-p and fluido 2?

kwin avatar Nov 05 '24 07:11 kwin

I think it is time for an update again. @michael-o Do you take it up or should I take over to bump to latest m-site-p and fluido 2?

Let me finish Fluido release today first.

michael-o avatar Nov 05 '24 08:11 michael-o

sure thank you

On Tue, Nov 5, 2024 at 3:35โ€ฏAM Michael Osipov @.***> wrote:

I think it is time for an update again. @michael-o https://github.com/michael-o Do you take it up or should I take over to bump to latest m-site-p and fluido 2?

Let me finish Fluido release today first.

โ€” Reply to this email directly, view it on GitHub https://github.com/apache/maven-site/pull/525#issuecomment-2456543626, or unsubscribe https://github.com/notifications/unsubscribe-auth/A3RYIUKKA6HWWP26VOWYAULZ7B7LHAVCNFSM6AAAAABHSV3YC2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJWGU2DGNRSGY . You are receiving this because you are subscribed to this thread.Message ID: @.***>

ditbace avatar Nov 05 '24 13:11 ditbace

@kwin skin is on Central, you can upgrade this PR.

michael-o avatar Nov 05 '24 18:11 michael-o

I just did, pushed the updated and cross-checked the result. Looks good to me. @slawekjaranowski Would you mind having another look?

kwin avatar Nov 07 '24 15:11 kwin

Ok found one regression with table headers, they are by default centered and no longer left-aligned:

Screenshot 2024-11-07 at 17 47 51

This seems to have regressed with https://github.com/apache/maven-fluido-skin/commit/85123d7be9f42c98712ff94e18619095ab284a9f. @michael-o Any idea?

kwin avatar Nov 07 '24 16:11 kwin

lost anchors with toc at https://maven.apache.org/settings.html

The anchor format changed (using uppercase), unfortunately https://github.com/apache/maven-site/blob/e225ba9c417830bea36e03285ec52f8330790d07/content/markdown/settings.md?plain=1#L20 uses no macro but a hardcoded list and relies on implementation details of the anchor format.

Update: I raised https://github.com/apache/maven-site/pull/574 to fix this.

kwin avatar Nov 07 '24 17:11 kwin

If there is no further concerns, I am gonna merge tomorrow. The table column alignment has been meanwhile clarified in https://issues.apache.org/jira/browse/MSKINS-230.

kwin avatar Nov 12 '24 18:11 kwin

If there is no further concerns, I am gonna merge tomorrow. The table column alignment has been meanwhile clarified in https://issues.apache.org/jira/browse/MSKINS-230.

Go ahead

michael-o avatar Nov 12 '24 21:11 michael-o