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

Add tooltip inline macro in order to display extra info in config table #1406

Merged
merged 1 commit into from
Apr 27, 2022
Merged

Add tooltip inline macro in order to display extra info in config table #1406

merged 1 commit into from
Apr 27, 2022

Conversation

michalvavrik
Copy link
Member

Enum constant documentation is not propagated to Quarkus website. One example- io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification has clear documentation of what REQUIRED, CERTIFICATE_VALIDATION and NONE means, however you won't find that in documentation. The meaning of this constants was enigma for me till I checked the codes, but if we want developers to do that, there is no point of providing Quarkus website at the first place.

My idea is that we use tooltip to show description. In io.quarkus.annotation.processor.generate_doc.ConfigDoItemFinder#extractEnumValues if there is constant description, we append value like this tooltip:REQUIRED[+++Certificates are validated and hostname verification is enabled. This is the default value.+++] and we alter io.quarkus.annotation.processor.generate_doc.SummaryTableDocFormatter#TABLE_ROW_FORMAT to prefix respective cell delimiter with a.

tooltip-hover

I am happy to implement the other part (in quarkus annotation processor), but it does not make sense till we have a way to display description.

@gastaldi gastaldi requested a review from insectengine April 25, 2022 04:06
@michalvavrik
Copy link
Member Author

I just mentioned that in some cases you use border-radius: 10px;, I can change my commit to match that if that's preferred.

@insectengine
Copy link
Collaborator

I'm fine with the new tooltip (with a 10px radius to match our buttons and cards).

@michalvavrik
Copy link
Member Author

thanks @insectengine , border radius fix is pushed

@gsmet
Copy link
Member

gsmet commented Apr 26, 2022

This is a good idea for sure. Let's see what CI has to say.

@gsmet gsmet merged commit 41a265e into quarkusio:develop Apr 27, 2022
@gsmet
Copy link
Member

gsmet commented Apr 27, 2022

Merged, thanks!

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

Successfully merging this pull request may close these issues.

3 participants