Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump Maven Site Plugin AND Maven Fluido Skin #525

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

michael-o
Copy link
Member

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

@slawekjaranowski
Copy link
Member

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 😄

Copy link
Member

@slawekjaranowski slawekjaranowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

more testing required ... I see empty pages

@michael-o
Copy link
Member Author

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
Copy link
Member Author

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
Copy link
Member Author

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

@slawekjaranowski
Copy link
Member

release history:
image

@slawekjaranowski
Copy link
Member

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
Copy link
Member

alignment also changed:
image

@michael-o
Copy link
Member Author

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
Copy link
Member Author

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
Copy link
Member Author

release history: image

Done.

@michael-o
Copy link
Member Author

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 :-(

@kwin
Copy link
Member

kwin commented May 12, 2024

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?

@michael-o
Copy link
Member Author

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
Copy link
Member Author

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
Copy link
Member Author

@michael-o
Copy link
Member Author

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

@michael-o
Copy link
Member Author

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
Copy link
Member Author

I will factor out the document fixes first...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants