Skip to content

docs: Enhance README with detailed usage and implementation information#15

Open
trygu wants to merge 2 commits intostatisticsnorway:mainfrom
trygu:main
Open

docs: Enhance README with detailed usage and implementation information#15
trygu wants to merge 2 commits intostatisticsnorway:mainfrom
trygu:main

Conversation

@trygu
Copy link
Member

@trygu trygu commented Feb 27, 2026

This pull request significantly expands and clarifies the README.md documentation for the LabID token exchange service. The changes provide a comprehensive overview of the service's purpose, implementation details, endpoint behavior, and configuration options, making it much easier for developers and users to understand how LabID works and how to integrate with it. Additionally, the contributing guidelines have been reorganized for clarity.

Overview and purpose:

  • Added a detailed "What it does" section explaining LabID's role as a Kubernetes token-exchange service, including its validation, group mapping, JWT signing, and endpoint exposure.
  • Introduced a "Background / Why it exists" section outlining the motivations for LabID, such as centralizing authentication and simplifying group-based authorization.

johnksv
johnksv previously approved these changes Feb 27, 2026
Copy link
Member

@johnksv johnksv left a comment

Choose a reason for hiding this comment

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

Better documentation than what we had previously! Great

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.

2 participants