chore: clarify Okta configuration fields #662
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Okta OIDC configuration documentation to provide clearer, more practical configuration examples. Instead of describing configuration values in a generic list format, it now provides specific examples for both Helm and Docker deployment methods.
- Replaces generic configuration description with concrete Helm and Docker examples
- Adds CodeGroup component to show both deployment methods side-by-side
- Includes all necessary configuration fields with example values and explanatory comments
| oauthClientId: "Client ID" # (starts with `0o`) | ||
| oauthClientSecret: "Client secret" |
There was a problem hiding this comment.
The example values "Client ID" and "Client secret" are placeholder text that could be confusing. Consider using more obviously placeholder values like <your-client-id> or YOUR_CLIENT_ID_HERE to make it clear these need to be replaced with actual values.
Copilot uses AI. Check for mistakes.
| OAUTH_CLIENT_ID="Client ID" # (starts with `0o`) | ||
| OAUTH_CLIENT_SECRET="Client secret" |
There was a problem hiding this comment.
Same issue as the Helm example - the placeholder values "Client ID" and "Client secret" should use more obvious placeholder formatting to prevent users from literally copying these strings.
Copilot uses AI. Check for mistakes.
|
Preview ID generated: preview-briane-1758898091-8fe4517 |
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
|
Preview ID generated: preview-briane-1759109150-ea11fc7 |
|
Preview ID generated: preview-briane-1759109424-f8140c9 |
Overview
Update Okta OIDC configuration section to make it clear it is through Helm/Docker
Type of change
Type: Update existing documentation
Related issues/PRs
Checklist
docs devsrc/docs.jsonif neededAdditional notes