Skip to content

Conversation

@raupachz
Copy link
Contributor

Hello,

my try on improving the Downloads page.

System requirements are now inline with the text. I don't think there is a need for everything mentioned and it is less visually dominated now.

Other releases is removed and its content is moved into Apache Maven and Maven Daemon. Daemon got its own section. If it were my call I would even go as far and drop Maven Daemon from the Downloads page. Not saying it is great tech, but the page is about downloading Maven not about Daemon.

I swapped the position of 4.x and older 3.8.x. I think this is better. Always nice to show that things are moving forward, but not ignoring the older versions.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Run mvn site and examine output in target/site directory.
    Site will also be built on your pull request automatically and attached to GitHub Action result.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@raupachz
Copy link
Contributor Author

Ah. Sorry. I messed up. That is more than one commit. Even one that shouldn't belong here. I will try to sequeeze it into again.

@Bukama
Copy link
Contributor

Bukama commented Oct 12, 2025

If it were my call I would even go as far and drop Maven Daemon from the Downloads page.

It was added earlier this year (#719) as there is no other download page for Daemon. And I think it's fine. It's a (and the only which needs external download) tool by the Maven team and of Maven.

--
About the PR: I like to update the structure to have Maven releases together and Maven Daemon releases together.

We should make sure use this PR to also fix headings

On live page it is:

  • H1: Downloading Maven 3.9.11
    • H2: System requirements
    • H2: Maven Daemon
  • H1: Other releases
    • H2: Previous Maven 3.8
    • H2: Preview Maven 4
    • H2: Preview Daemon 2

This violates basic rules of HTML where only one H1 is allowed for the page title, which is not Downloading Maven 3.9.11 but should "Downloding Apache Maven - Maven" according to title tag. I think "Downloading Maven" is better.

The then following structure should be something like this

  • H1 Download Maven
  • H2: Maven
    • H3: Current Stable: Maven 3.9.11
    • H3: Preview 4.x
    • H3: Previous Maven 3.8
  • H2: Maven Daemon
    • H3: Current Stable: Maven Daemon 1
    • H3: Preview Daemon 2

And also add a TOC to the page so users can jump to the section they want

@raupachz
Copy link
Contributor Author

@Bukama

The then following structure should be something like this

Your proposal also has two H1s. Mistake?

H1: Download Maven
H2: Maven
H2: Maven Daemon

Like this?

@Bukama
Copy link
Contributor

Bukama commented Oct 18, 2025

@Bukama

The then following structure should be something like this

Your proposal also has two H1s. Mistake?

H1: Download Maven H2: Maven H2: Maven Daemon

Like this?

opps yeah and the one below then H3. Will edit.

edit: also renamed PR title cause it's about download page

@Bukama Bukama changed the title Tidied up documentation page Tidied up download page Oct 18, 2025
@Bukama
Copy link
Contributor

Bukama commented Oct 18, 2025

When you update your PR, please rebase it - the current diff contains a lot of changes from earlier/merged PRs. Thank you!

However, this still required the usage of the [Flatten Maven Plugin][20] for full functionality.
Since Maven 4, no additional plugin is needed; full built-in support is provided.
You can now use variables as versions in your configuration.
You can now use **any variable** as versions in your configuration, not just predefined ones.
Copy link
Contributor

Choose a reason for hiding this comment

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

as a version


### Maven Upgrade Tool

If you're currently using Maven 3 and want to upgrade to Maven 4, you can use the [Maven Upgrade Tool](https://maven.apache.org/tools/mvnup.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

"If you're currently using Maven 3 and want to upgrade to Maven 4" -- "To upgrade from maven 3 to Maven 4"


The Maven Upgrade Tool tool can be used to:

* Automatically update your POM files to use the new model version 4.1.0 (if desired)
Copy link
Contributor

Choose a reason for hiding this comment

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

Delete "Automatically"


* Automatically update your POM files to use the new model version 4.1.0 (if desired)
* Identify deprecated features and suggest replacements
* Help migrate from deprecated plugin configurations to their modern equivalents
Copy link
Contributor

Choose a reason for hiding this comment

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

Delete "Help"

* System requirements are now less dominant
* Maven Maven Daemon has its own section
* Removed other releases into Apache Maven and Daemon section
* Swapped the positions of Maven 4.x and 3.8.x releases
@raupachz
Copy link
Contributor Author

@elharo

When you update your PR, please rebase it - the current diff contains a lot of changes from earlier/merged PRs. Thank you!

I messed up. Your comments ended up on the wrong PR. My bad.

@raupachz
Copy link
Contributor Author

@Bukama

And also add a TOC to the page so users can jump to the section they want

I like all your idea, but I am a bit stuck at the moment. Haven't figured out this whole Velocity and Maven Fluido Skin combination.

@Bukama
Copy link
Contributor

Bukama commented Oct 26, 2025

@Bukama

And also add a TOC to the page so users can jump to the section they want

I like all your idea, but I am a bit stuck at the moment. Haven't figured out this whole Velocity and Maven Fluido Skin combination.

sure, just ping me if you want another review or help (not sure where you are stucked exactly atm)

@raupachz
Copy link
Contributor Author

Hi @Bukama

thanks for getting in touch. Very much appreciated.

Here is where I am stuck at the moment.

I am trying to implement your proposal:

H1 Download Maven
H2: Maven
H3: Current Stable: Maven 3.9.11
H3: Preview 4.x
H3: Previous Maven 3.8
H2: Maven Daemon
H3: Current Stable: Maven Daemon 1
H3: Preview Daemon 2

dnd also add a TOC to the page so users can jump to the section they want.

The file download.xml.vm is processed by Apache Velocity. At least I think it is.

I haven't figured out where the whole magic happens.

<section name="...">

renders a H1 .

<subsection name="...">

renders a h2. There is no <subsubsection> to render a H3.

And I haven't looked into deeply enough into the templating stuff long enough to find out if there is a TOC element or macro. Not sure what the proper naming is.

@slawekjaranowski
Copy link
Member

Please wait for

I'm going to merge it at the end of month

@Bukama
Copy link
Contributor

Bukama commented Oct 27, 2025

... to find out if there is a TOC element or macro.

For TOC you can use the following in .apt.vm files (adjust parameters so they fit)

%{toc|section=0|fromDepth=2|toDepth=5}

I am trying to implement your proposal:

You should be able to just work with

** H2
*** H3 

as the base is still .apt
At least this is what I see in an old .apt.vm file I converted to markdown

https://github.com/apache/maven-site/pull/1372/files#diff-0b119b138d8a4db3df277ed507975265c891da9d5752df3e6e6f1b4c69792d8dL29

Hope this helps, otherwise I would have to have a closer look myself tomorrow.

@Bukama
Copy link
Contributor

Bukama commented Oct 27, 2025

Please wait for

I'm going to merge it at the end of month

Sure :)

@Bukama
Copy link
Contributor

Bukama commented Nov 7, 2025

@raupachz The 3.8 EOL has been merged, you can update the PR if you want :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants