chore: clarify Okta configuration fields - #662
Merged
Merged
Conversation
Brian Vander Schaaf (bvs-langchain)
requested a review
from Lauren Hirata Singh (lnhsingh)
as a code owner
September 26, 2025 14:45
Brian Vander Schaaf (bvs-langchain)
requested a review
from Kathryn May (katmayb)
as a code owner
September 26, 2025 14:45
Contributor
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
Comment on lines
+190
to
+191
| 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.
Comment on lines
+201
to
+202
| 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.
Kathryn May (katmayb)
approved these changes
Sep 26, 2025
Kathryn May (katmayb)
left a comment
Kathryn May (katmayb)
left a comment
Contributor
There was a problem hiding this comment.
Small non-blocking nit, lgtm 👍
Contributor
|
Preview ID generated: preview-briane-1758898091-8fe4517 |
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
Contributor
|
Preview ID generated: preview-briane-1759109150-ea11fc7 |
Contributor
|
Preview ID generated: preview-briane-1759109424-f8140c9 |
Lauren Hirata Singh (lnhsingh)
deleted the
brian/ent-100-okta-clarify
branch
September 29, 2025 10:54
Mason Daugherty (mdrxy)
pushed a commit
that referenced
this pull request
Oct 1, 2025
## Overview <!-- Brief description of what documentation is being added/updated --> Update Okta OIDC configuration section to make it clear it is through Helm/Docker ## Type of change **Type:** Update existing documentation ## Related issues/PRs <!-- Link to related issues, feature PRs, or discussions (if applicable) To automatically close an issue when this PR is merged, use closing keywords: - "closes #123" or "fixes #123" or "resolves #123" For regular references without auto-closing, just use: - "#123" or "See issue #123" Examples: - closes #456 (will auto-close issue #456 when PR is merged) - See #789 for context (will reference but not auto-close issue #789) --> - GitHub issue: - Feature PR: <!-- For LangChain employees, if applicable: --> - Linear issue: part of ent-100 - Slack thread: ## Checklist <!-- Put an 'x' in all boxes that apply --> - [ ] I have read the [contributing guidelines](README.md) - [ ] I have tested my changes locally using `docs dev` - [ ] All code examples have been tested and work correctly - [ ] I have used **root relative** paths for internal links - [ ] I have updated navigation in `src/docs.json` if needed - I have gotten approval from the relevant reviewers - (Internal team members only / optional) I have created a preview deployment using the [Create Preview Branch workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml) ## Additional notes <!-- Any other information that would be helpful for reviewers --> --------- Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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