Skip to content

Maven layers documentation is incomplete #21555

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.

Sign up for GitHub

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

Jump to bottom
Closed
philwebb opened this issue May 25, 2020 · 3 comments
Closed

Maven layers documentation is incomplete #21555

philwebb opened this issue May 25, 2020 · 3 comments
Assignees
@scottfrederick
Labels
type: documentation A documentation update
Milestone
2.3.5

Comments

@philwebb
Copy link
Member

The following isn't really that helpful:

https://docs.spring.io/spring-boot/docs/current/maven-plugin/reference/html/#goals-build-image-parameters-details-layers

We could also do with a link from "Building OCI Images" to "Layered Jars" since it's hidden in the ToC.
@philwebb philwebb added this to the 2.3.x milestone May 25, 2020
@philwebb philwebb added the type: documentation A documentation update label May 25, 2020
@snicoll
Copy link
Member

snicoll commented May 25, 2020

The following isn't really that helpful:

I am not sure what you mean by that. This is a rendering of what the Maven plugin generates and choosing a nested type for a parameter as we've decided is unfortunately not supported by Maven.

@philwebb
Copy link
Member Author

I wasn't sure how we generated it. I was hoping we could link out to the Javadoc of the class

@snicoll
Copy link
Member

snicoll commented Sep 1, 2020

DocumentPluginGoals is generating the file so we could generate Javadoc links when we detect a matching type.

@scottfrederick scottfrederick self-assigned this Oct 16, 2020
@scottfrederick scottfrederick mentioned this issue Oct 16, 2020
Closed
@scottfrederick scottfrederick modified the milestones: 2.3.x, 2.3.5 Oct 16, 2020
scottfrederick added a commit that referenced this issue Oct 19, 2020
@scottfrederick
Polish Maven plugin javadoc
38b1954 
This commit polishes the javadoc for Maven plugin classes now that
the plugin reference docs link to the javadoc. Visibility of some
MOJO parameter class getters and setters were also changed for
consistency.

See gh-21555
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@scottfrederick scottfrederick

Labels
type: documentation A documentation update
Projects
None yet
Milestone
2.3.5
Development

No branches or pull requests
3 participants
@scottfrederick @snicoll @philwebb