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

Make the name of the configuration adoc file configurable #36189

Closed
ppalaga opened this issue Sep 28, 2023 · 1 comment · Fixed by #36195
Closed

Make the name of the configuration adoc file configurable #36189

ppalaga opened this issue Sep 28, 2023 · 1 comment · Fixed by #36195

Comments

@ppalaga
Copy link
Contributor

ppalaga commented Sep 28, 2023

Description

Currently the name of the AsciiDoc file with the docs of the individual properties is transformed from @ConfigRoot.name() . E.g. if the name() is quarkus.cxf then the generated file will be <tree-root>/target/asciidoc/generated/config/quarkus-cxf.adoc. This works well as long as the names are unique throughout the extensions hosted within the current source tree or as long as one wants to output the docs of the properties coming from all extensions using the same @ConfigRoot.name() to the same adoc file.

In Quarkus CXF this is not what we want. We have several extensions which enhance the main quarkus.cxf config on lower levels of the configuration tree.

The main config in the core extension has naturally @ConfigRoot(name = "quarkus.cxf"). It allows basic configuration of clients and services via

quarkus.cxf.client.myClient.wsdl = ...
quarkus.cxf.client.myClient.client-endpoint-url = ...
...
quarkus.cxf.endpoint."/hello".implementor = ...

But then there is a couple of other extensions, which also need to have @ConfigRoot(name = "quarkus.cxf") because they hook somewhere deeper in the config hierarchy. E.g. our logging extension allows the following:

quarkus.cxf.client.myClient.logging.enabled = true
quarkus.cxf.client.myClient.logging.pretty = true
...
quarkus.cxf.endpoint."/hello".logging.enabled = true
quarkus.cxf.endpoint."/hello".logging.pretty = true

At the same time, we want to have two separate property adoc files for the core extension and for the logging extension because we want to include them on two separate extension pages.

This is currently not possible, because all property doc chunks land in <tree-root>/target/asciidoc/generated/config/quarkus-cxf.adoc

Implementation ideas

Add a new attribute on @ConfigRoot specifying the name of the destination adoc file.

A PR follows.

@quarkus-bot
Copy link

quarkus-bot bot commented Sep 28, 2023

/cc @MichalMaler (documentation), @ebullient (documentation), @inoxx03 (documentation), @michelle-purcell (documentation), @rolfedh (documentation), @sheilamjones (documentation), @sunayna15 (documentation)

@quarkus-bot quarkus-bot bot added this to To do in Quarkus Documentation Sep 28, 2023
@ppalaga ppalaga self-assigned this Sep 28, 2023
ppalaga added a commit to ppalaga/quarkus-cxf that referenced this issue Sep 28, 2023
ppalaga added a commit to ppalaga/quarkus-cxf that referenced this issue Sep 28, 2023
Quarkus Documentation automation moved this from To do to Done Oct 6, 2023
@quarkus-bot quarkus-bot bot added this to the 3.5 - main milestone Oct 6, 2023
ppalaga added a commit to ppalaga/quarkus-cxf that referenced this issue Oct 11, 2023
ppalaga added a commit to ppalaga/quarkus-cxf that referenced this issue Oct 14, 2023
ppalaga added a commit to quarkiverse/quarkus-cxf that referenced this issue Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants