-
Notifications
You must be signed in to change notification settings - Fork 3k
Allow to set default value for config options with AsciiDoc attributes in the docs #51098
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
base: main
Are you sure you want to change the base?
Allow to set default value for config options with AsciiDoc attributes in the docs #51098
Conversation
gsmet
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.
Looks mostly good, thanks a lot. I added a couple of minor comments.
...-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/AbstractFormatter.java
Outdated
Show resolved
Hide resolved
core/runtime/src/main/java/io/quarkus/runtime/annotations/ConfigDocDefault.java
Outdated
Show resolved
Hide resolved
...java/io/quarkus/annotation/processor/documentation/config/scanner/ConfigMappingListener.java
Outdated
Show resolved
Hide resolved
...java/io/quarkus/annotation/processor/documentation/config/scanner/ConfigMappingListener.java
Outdated
Show resolved
Hide resolved
Thanks! Processed your feedback, if it looks good I can squash the commits |
bb41584 to
a565a95
Compare
This comment has been minimized.
This comment has been minimized.
|
🎊 PR Preview 271f56c has been successfully built and deployed to https://quarkus-pr-main-51098-preview.surge.sh/version/main/guides/
|
This comment has been minimized.
This comment has been minimized.
gsmet
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.
I added a few comments.
extensions/narayana-lra/deployment/src/main/java/lra-devservice.properties
Outdated
Show resolved
Hide resolved
|
Also, not sure if you're aware but we can probably also improve things for these (not sure they are all used for Dev Services but at least some of them are): |
1934889 to
4915616
Compare
This comment has been minimized.
This comment has been minimized.
4915616 to
80dcb3f
Compare

Make it possible to use AsciiDoc attributes directly in the
ConfigDocDefaultannotation. This is especially useful to pass Maven properties as AsciiDoc attributes to the config properties as a default value for the documentation.For example, we now define the
keycloak.docker.imagein a central place, however we lost the default value in the documentation. With this change we can also use AsciiDoc attributes as default value again for the documentation.This should cover the initial idea from @gsmet, see #51024 (comment)
Locally this rendered the default value again for the Keycloak Docker image
Once integrated we can also do this for the other Dev Services.