Skip to content

docs: move using kuadrant from guides into readme for guides - #523

Open
KevFan wants to merge 3 commits into
Kuadrant:mainfrom
KevFan:issues/519
Open

docs: move using kuadrant from guides into readme for guides#523
KevFan wants to merge 3 commits into
Kuadrant:mainfrom
KevFan:issues/519

Conversation

@KevFan

@KevFan KevFan commented Feb 26, 2025

Copy link
Copy Markdown
Contributor

Description

Closes: #519

Move out the "Using Kuadrant" from the user guides to keep the user guides focused on AuthConfig. Instead a README.md is introduced describing Kuadrant AuthPolicy as a consumer of the AuthConfig

@KevFan
KevFan force-pushed the issues/519 branch 2 times, most recently from 766a413 to 2145a62 Compare February 27, 2025 11:25
@KevFan KevFan self-assigned this Feb 27, 2025
@KevFan KevFan added area/doc Improvements or additions to documentation size/small labels Feb 27, 2025
@KevFan
KevFan marked this pull request as ready for review February 27, 2025 11:33
@KevFan KevFan added this to Kuadrant Jul 21, 2025
@KevFan KevFan moved this to Ready For Review in Kuadrant Jul 21, 2025
@KevFan
KevFan requested a review from a team July 23, 2025 11:07
KevFan added 3 commits July 23, 2025 12:07
Signed-off-by: KevFan <chfan@redhat.com>
Signed-off-by: KevFan <chfan@redhat.com>

@guicassolato guicassolato left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

⚠️ Cons:

  • 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:

  1. 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.

  2. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/doc Improvements or additions to documentation size/medium

Projects

Status: Ready For Review

Development

Successfully merging this pull request may close these issues.

docs: move "Using Kuadrant" portion in user guides into a README of user-guides directory

2 participants