Clarify usage of quarkus-keycloak-admin-rest-client and quarkus-keycloak-admin-resteasy-client

[rolfedh]

Clarify usage of quarkus-keycloak-admin-rest-client and quarkus-keycloak-admin-resteasy-client.

[github-actions]

🙈 The PR is closed and the preview is expired.

[sberyozkin]

Hi Rolfe, neither quarkus-keycloak-admin-rest-client nor quarkus-keycloak-admin-resteasy-client are currently supported, so I'm not sure if these exclusions are correct...

[rolfedh]

Hi Rolfe, neither quarkus-keycloak-admin-rest-client nor quarkus-keycloak-admin-resteasy-client are currently supported, so I'm not sure if these exclusions are correct...

If the Keycloak Admin Client (KAC) isn’t supported in the product, then the current conditionalization is (mostly) correct.

Using the ifndef:: directive to enclose KAC content ensures it appears in the community docs but remains hidden in the product documentation.

The only concern I see is that updating the conditional to no-quarkus-keycloak-admin-resteasy-client might make it too specific, applying only to one of the unsupported extensions. (Is this what you were referencing in your comment?)

Perhaps it would be better to retain no-quarkus-keycloak-admin-client, as it more transparently reflects its role in hiding both extensions. What are your thoughts?

[sberyozkin]

@rolfedh

The only concern I see is that updating the conditional to no-quarkus-keycloak-admin-resteasy-client might make it too specific, applying only to one of the unsupported extensions. (Is this what you were referencing in your comment?)

Yes,

Perhaps it would be better to retain no-quarkus-keycloak-admin-client, as it more transparently reflects its role in hiding both extensions. What are your thoughts?

If it can hide both extensions then it would indeed be the right solution

Thanks

[rolfedh]

If it can hide both extensions then it would indeed be the right solution

Yes, it does. I’ve verified that this setup correctly handles all instances of these extensions in both the upstream and downstream documentation.

This PR will focus solely on elaborating on the existing note, not on updating the conditionals. Additionally, I’ll include a note in the downstream attributes to clarify the dual role of no-quarkus-keycloak-admin-client and its relationship to both quarkus-keycloak-admin-rest-client and quarkus-keycloak-admin-resteasy-client.

[michalvavrik]

thanks @rolfedh

[rolfedh]

I had to make another push to restore the cross reference to the Keycloak guide on line 244. We have approvals from @sberyozkin and @michalvavrik. I think this PR is only needs final review and merge from @gsmet. Thank you all for your contributions and reviews!

[quarkus-bot]

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit fa620fa.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

[sberyozkin]

Guillaume, @gsmet, please double check if you can get a few minutes as Rolfe would like you to review, thanks

[gsmet]

Yes, it was on my list :).