docs: move using kuadrant from guides into readme for guides - #523
Open
KevFan wants to merge 3 commits into
Open
docs: move using kuadrant from guides into readme for guides#523KevFan wants to merge 3 commits into
KevFan wants to merge 3 commits into
Conversation
KevFan
force-pushed
the
issues/519
branch
2 times, most recently
from
February 27, 2025 11:25
766a413 to
2145a62
Compare
KevFan
marked this pull request as ready for review
February 27, 2025 11:33
Signed-off-by: KevFan <chfan@redhat.com>
Signed-off-by: KevFan <chfan@redhat.com>
Signed-off-by: KevFan <chfan@redhat.com>
guicassolato
reviewed
Jul 7, 2026
guicassolato
left a comment
Collaborator
There was a problem hiding this comment.
While revisiting this, I had doubts about centralising the disclaimer for Kuadrant users in a separate doc that one could easily overlook. However, I now think it's worthwhile the trade-offs, which I'd probably summarise as follows:
✅ Pros:
- Reduced noise for direct Authorino users - The guides become cleaner and more focused on their core purpose (demonstrating AuthConfig features). The current boxes interrupt the flow twice per guide.
- Better discoverability of limitations - The centralised README explicitly lists features NOT available via Kuadrant (Sharding, Host Override), which is harder to communicate in repeated inline boxes.
- Single source of truth - Information about Kuadrant integration lives in one place, making it easier to:
- Keep consistent across all guides
- Update when the relationship changes
- Add other AuthConfig consumers in the future
- Improved maintenance - Fewer places to update when Kuadrant's API or relationship changes.
- Scalability - If other projects become AuthConfig consumers – at the same as Kuadrant, we add one section to README.md instead of modifying tens of other files.
- Discoverability (the other side) - Kuadrant users following a specific guide might miss the README and get confused when instructions mention AuthConfig instead of AuthPolicy.
- Context switch - Users need to jump to another doc to understand the Kuadrant-specific adaptations. The inline boxes provided just-in-time reminders.
- First-time user experience - Someone coming from Kuadrant docs might land on a specific guide via search/link and not see the README context.
If I may suggest only a couple of enhancements before we go ahead and merge this PR:
- Keep a single brief callout at the top of the guides:
Using AuthConfig via Kuadrant or other tools? See the AuthConfig Consumers guide for adaptation notes.
- Ensure the README is prominently featured in the navigation – E.g., add a link to it from the main README of the repo and user guide index page.
If there's anybody interested in taking ownership of this and implement these suggestions, I'll be glad to approve them.
This file contains hidden or 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
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.
Description
Closes: #519
Move out the "Using Kuadrant" from the user guides to keep the user guides focused on
AuthConfig. Instead aREADME.mdis introduced describing KuadrantAuthPolicyas a consumer of theAuthConfig