docs: restructure authentication docs#256
Conversation
Split scattered auth content into a clear hub: - Replace getting_started/service-accounts with a thin authenticating_to_kosli intro that points to the deep pages. - New Administration > "Authentication & access" group with api_authentication_methods (bearer + basic auth, closes #89), service_accounts (admin lifecycle), and api_key_rotation reference. - New top-level "User" group with default_organization (moved from Administration, where it was misfiled) and personal_api_keys. - Rename "Managing Users" group to "Users & roles"; split roles_in_kosli mapping content into a new mapping_users_to_roles page and clarify that roles apply to service accounts too. - Add redirects for the two moved URLs and update all internal cross-links across tutorials and labs.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @dangrondahl's task in 1m 58s —— View job Review: PR #256 — Authentication docs restructure
Overall assessmentThis is a well-structured reorganization. The three-part spine (Getting started landing page → Administration auth group → User personal settings) is a clear improvement over the previous single service-accounts page. All new pages are registered in The previous review round (6 comments) already covered the main suggestions. Most of those were non-blocking and several have been addressed in subsequent commits (least-privilege guidance, personal key revocation section). I have a few additional observations below. FindingsImprovement
Suggestion
Navigation ordering — "User" group placement
Summary
Strong PR. The information architecture is much clearer, the HTTP basic auth documentation fills a real gap, and the migration mechanics (redirects, cross-link updates) are thorough. No blocking issues found. |
- Fix link text in lab-01: "Service Accounts" → "Authenticating to Kosli"
so the text matches the target page.
- Apply sentence case to roles_in_kosli.md headings ("Assigning roles",
"Best practices", and the four h3s under Best practices) per CLAUDE.md.
- Downgrade the redundant "legacy method" Warning in basic auth to a
Note so two callouts don't stack visually.
- Trim the duplicated CLI token-passing list from
authenticating_to_kosli; the canonical home is
api_authentication_methods.
- Add Admin to the service-account role guidance for the rare
case (Terraform-driven org bootstrap, automation that manages
users) so readers don't wonder.
- Remove the three {/* TODO */} placeholders. The pages stand
on their own; deeper coverage will land as separate PRs.
- Service-account role section gets an explicit "pick the least-privileged role" line so the guidance is scannable. - Personal API keys page documents how to revoke a key.
Summary
Restructure scattered authentication content into a clear three-part spine:
Other changes in this PR:
roles_in_kosli.mdinto a newmapping_users_to_roles.mdpage.Test plan