Thanks, Björn, for your feedback.
I share your opinion that the official documentation has lots of great
content. Therefore, we create an information architecture [1] that is
based on the content of the official documentation.
I doubt the official Maven documentation will ever get a modern technical
foundation. It takes too much effort. It still runs Bootstrap v2.3.2 and
efforts to put it on modern feet have been tried, but weren’t finished for
whatever reason.
For me, the question is, what costs more time? Modernize the current
technical foundation or move to another technology that fulfills the
requirements of modern documentation.
At the end, the technical base and the information architecture of our
PoC are proposals. They should help to improve the Maven documentation.
Best regards,
Sandra
[1]
https://github.com/support-and-care/doc-for-maven/blob/main/information-architecture.md
Am 24.10.26 um 13:44 schrieb Björn Raupach:
Hello Sandra,
Thank you very much for taking the time to create more modern documentation. I
really appreciate the time and effort.
Before I join the GitHub discussion, I think it is worth talking a bit in this
thread, in the hopes of getting more people into the loop.
In my opinion, an improved documentation is something Maven really needs, even
more so with Maven 4 coming out soon. This can only be achieved with
contributions from the community.
Documentation is all about content and structure.
The official Maven documentation at https://maven.apache.org/ has lots of great
content but it lacks structure. It is hard to navigate. There are so many
topics thrown at you, which most of the average users don’t need or care about.
It is written by technical people for technical people. User guides, plugins
development and Maven internals are not well separated from each others. Should
be. Make it much more readable.
That’s imho of highest priority and second is a more modern technical
foundation.
No offense to all the great people, like Matthias Bünger who also put a lot of
time into improving the site.
Although I believe it is possible to restructure the official Maven
documentation, it requires too much technical expertise for average joes like
myself. Therefore I have a hard time contributing.
I doubt the official Maven documentation will ever get a modern technical
foundation. It takes too much effort. It still runs Bootstrap v2.3.2 and
efforts to put it on modern feet have been tried, but weren’t finished for
whatever reason.
[1] https://github.com/apache/maven-fluido-skin/issues/125
On 22. Oct 2026, at 18:54, Sandra Parsick <[email protected]> wrote:
Hi,
In the context of Support & Care [1], we create a proof of concept of how
modern Maven documentation could look: https://docs.maven-starter.io/
Many pages have dummy content because we want to see what kind of structure
could work for us. But some pages already have content to find out what kind of
different documentation style could look like, for example:
- Your first Maven build in 5 minutes [2]
- What is Maven (for)? [3]
- How to add and exclude dependencies [4]
- Write your first Maven 3 plugin in Java [5]
- The dependency mechanism [6]
- Installing Apache Maven [7]
We have also invested time in writing a guide [8] and describing how an
information architecture [9] for Maven could look for it, so
We have opened a GitHub discussion [10] if you want to give us feedback.
We are also planning to add more content to it in the future.
Cheers,
Sandra
[1] https://open-elements.com/support-care
[2] https://docs.maven-starter.io/app-developer/getting-started/first-build/
[3] https://docs.maven-starter.io/app-developer/key-concepts/what-maven-is/
[4] https://docs.maven-starter.io/app-developer/how-to/add-exclude-dependencies/
[5] https://docs.maven-starter.io/plugin-developer/tutorials/first-java-plugin/
[6]
https://docs.maven-starter.io/app-developer/key-concepts/dependency-mechanism/
[7] https://docs.maven-starter.io/about/installation/
[8] https://github.com/support-and-care/doc-for-maven/blob/main/writing-guide.md
[9]
https://github.com/support-and-care/doc-for-maven/blob/main/information-architecture.md
[10] https://github.com/support-and-care/doc-for-maven/discussions
--
=======================
Freelancer | Software Developer | Java Champion
Mastodon: @[email protected]
Codeberg: https://codeberg.org/sparsick
Github: https://www.github.com/sparsick
Blog: https://blog.sandra-parsick.de
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
