Skip to content

Conversation

@kwin
Copy link
Member

@kwin kwin commented Jan 28, 2026

Place generated markdown source instead in
"target/generated-site/markdown/" which is included by default (https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#generatedSiteDirectory)

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.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • 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.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

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.

Place generated markdown source instead in
"target/generated-site/markdown/" which is included by default
(https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#generatedSiteDirectory)
@kwin kwin requested a review from cstamas January 28, 2026 09:17
@cstamas
Copy link
Member

cstamas commented Jan 28, 2026

Okay, and how will this file get to the site? As this md file is this page:
https://maven.apache.org/resolver/configuration.html

@cstamas
Copy link
Member

cstamas commented Jan 28, 2026

Okay, and how will this file get to the site? As this md file is this page: https://maven.apache.org/resolver/configuration.html

Oh, target/generated-site. Am fine with this, I don't use site so never knew about this feat, if works, great!

Copy link
Member

@cstamas cstamas left a comment

Choose a reason for hiding this comment

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

Blindly +1 as I dont know well the site feature

@kwin
Copy link
Member Author

kwin commented Jan 28, 2026

There is just an implicit dependency on the default Maven lifecycle, as just running mvn clean site will not generate it (https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#site-lifecycle) as the generation is bound to phase package. However changing this is not that easy as it requires the class file of org.eclipse.aether.tools.CollectConfiguration (generated in phase compile).

@cstamas
Copy link
Member

cstamas commented Jan 28, 2026

Given this same tool is used in maven4 to generated similar doco, we may pull this tool out (was done ad-hoc and quickly, but later proved very useful).
It all started with Resolver 1.x config page, that is still maintained manually, and lacks a lot of config as they simply fell to oblivion and was forgotten to be updated with PRs. I just hated manually maintaining that page, and is off/lacks entries even today.

https://github.com/apache/maven/blob/master/pom.xml#L1029-L1054
generates this page
https://maven.apache.org/ref/4.0.0-rc-5/maven-configuration.html

@kwin
Copy link
Member Author

kwin commented Jan 28, 2026

Let's start with this improvement now as is.

@kwin kwin merged commit 08f8381 into master Jan 28, 2026
21 checks passed
@kwin kwin deleted the bugfix/remove-configuration-md-source-from-git branch January 28, 2026 13:33
@github-actions
Copy link

@kwin Please assign appropriate label to PR according to the type of change.

@github-actions github-actions bot added this to the 2.0.15 milestone Jan 28, 2026
@kwin kwin added the documentation Improvements or additions to documentation label Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants