Improve documentation of configuration properties with type Map<String, NotAConfigGroup> #40335
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…g, NotAConfigGroup>
quarkus-bot
bot
added
area/config
area/core
area/elasticsearch
area/graphql
area/health
area/infinispan
|
/cc @brunobat (micrometer), @ebullient (micrometer), @gsmet (elasticsearch), @loicmathieu (elasticsearch) |
yrodiere
force-pushed
the
i40332-configMapDocs
branch
from
320698c to
ab91604
Compare
…property in dev services
…figuration properties
yrodiere
force-pushed
the
i40332-configMapDocs
branch
from
ab91604 to
32ee0a9
Compare
quarkus-bot
bot
added
area/agroal
area/flyway
area/openapi
area/redis
area/scheduler
labels
quarkus-bot
bot
added
area/security
area/spring
yrodiere
added
the
triage/needs-review
Status for workflow
|
|
Damn, Guillaume went on PTO before he had time to review this. I thought he of all people would be interested. @geoand maybe? :) |
|
It LGTM, but I not done any work around this area not have I followed discussions so I am hesitant to approve |
|
Bump @gsmet :) |
gsmet
approved these changes
May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #40332
Before the patch:
After the patch (without CSS, since I tested locally...):
Unfortunately, this PR needs to set the name of the map keys, which will break direct links to the relevant configuration properties in the docs. That's because anchors are generated from the displayed key, including the
"some-name"parts... which IMO is a dubious choice. We should probably change that to use anchors generated from some display-independent reference to the key. But that will result in breaking even more links, and anyway won't solve our problem here (since existing links will still be using the old anchor that includes the old"some-name"), so I won't do it in this PR.