Skip to content
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

Documentation for Maven Plugin classifier has an unresolved external reference #29171

Closed
mgiorgino opened this issue Dec 24, 2021 · 2 comments
Closed
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@mgiorgino
Copy link

There is what seems to be a failed template replacement at the end of the documentation about the classifier configuration option of the spring-boot-maven-plugin: see $1[$2]:

https://docs.spring.io/spring-boot/docs/2.5.x/maven-plugin/reference/htmlsingle/#goals-repackage-parameters-details-classifier
https://docs.spring.io/spring-boot/docs/2.6.2/maven-plugin/reference/htmlsingle/#goals-repackage-parameters-details-classifier

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Dec 24, 2021
@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Dec 25, 2021
@snicoll snicoll added this to the 2.5.x milestone Dec 25, 2021
@snicoll
Copy link
Member

snicoll commented Dec 25, 2021

Thanks for the report, this is a <a href instruction in the javadoc that our asciidoctor processor doesn't seem to handle.

@snicoll snicoll changed the title Failed template replacement in spring-boot-maven-plugin's "classifier" documentation Documentation for Maven Plugin classifier has an unresolved external reference Dec 25, 2021
@wilkinsona
Copy link
Member

wilkinsona commented Jan 9, 2022

The text in the plugin.xml that's used to generate the Asciidoctor source has been HTML escaped so <a href=" has become &lt;a href=&quot. This is also the case in 2.2 so it looks like Maven's site support copes with this escaping but our Asciidoctor-based documentation does not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

4 participants