-
Notifications
You must be signed in to change notification settings - Fork 144
Remove generated configuration.md from Git #1769
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
Conversation
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)
|
Okay, and how will this file get to the site? As this md file is this page: |
Oh, target/generated-site. Am fine with this, I don't use site so never knew about this feat, if works, great! |
cstamas
left a comment
There was a problem hiding this 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
|
There is just an implicit dependency on the default Maven lifecycle, as just running |
|
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). https://github.com/apache/maven/blob/master/pom.xml#L1029-L1054 |
|
Let's start with this improvement now as is. |
|
@kwin Please assign appropriate label to PR according to the type of change. |
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:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
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.