Kuadrant / Kuadrant/docs.kuadrant.io
Leverage the use cases and knowledge of AuthConfig but with an AuthPolicy context
- Dominant language
- Python
- Stars
- 24
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
** What **
There are many use cases covered by the Authorino docs using AuthConfig. AuthConfig is effectively a sub resource of the AuthPolicy. Ideally we would have a way to show how to solve these use cases using kuadrant's AuthPolicy. As AuthPolicy is a AuthConfig with policy attachment features. It should be possible to template a wrapper doc that calls out that the authconfig shown is effectively a drop in for the `authentication` section of the auth policy.
**Outcome**
using a new "Auth" template doc, under the Tutorials section, expand that to cover many of the common use cases outlined in Authorino https://github.com/Kuadrant/authorino?tab=readme-ov-file#use-cases to help the user understand what and how to achieve their auth requirements.
Contributor guide
Research direction
Start with the Authorino README use cases linked in the issue and compare them with the existing AuthConfig and AuthPolicy documentation. Create the proposed Auth template under Tutorials, showing how the AuthConfig examples map to the authentication section of an AuthPolicy; done means the common use cases are covered with clear Kuadrant guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100