Add documentation for enhanced organization authentication feature#6068
Open
SujanSanjula96 wants to merge 2 commits intowso2:masterfrom
Open
Add documentation for enhanced organization authentication feature#6068SujanSanjula96 wants to merge 2 commits intowso2:masterfrom
SujanSanjula96 wants to merge 2 commits intowso2:masterfrom
Conversation
Contributor
📝 WalkthroughWalkthroughAdded new wrapper documentation pages that set template variables and include shared organization-login guide content, created corresponding shared include files (some placeholders), and updated MkDocs navigation to expose the new guide pages under Guides → Organizations → Enable organization-based login. Changes
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
en/includes/guides/organization-management/organization-login/legacy-approach.md (1)
6-6: Complete the documentation content.This page contains only a placeholder comment and provides no guidance to users.
Do you want me to open an issue to track completion of this documentation?
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-management/organization-login/legacy-approach.md` at line 6, The file en/includes/guides/organization-management/organization-login/legacy-approach.md currently contains only a placeholder HTML comment; replace that placeholder by adding full documentation for the legacy organization login approach in this file (legacy-approach.md), including: a concise overview of the legacy flow, step-by-step instructions for users who still use the legacy login, migration guidance to the new login process, important security considerations, common troubleshooting Q&A, and links to related docs and APIs; remove the "<!-- TODO: Add content -->" comment and ensure headings, examples, and any CLI/URL snippets are accurate and consistent with existing docs conventions.en/includes/guides/organization-management/organization-login/app-native-authentication.md (1)
3-3: Complete the documentation content.This page contains only a placeholder comment and provides no guidance to users.
Do you want me to open an issue to track completion of this documentation?
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-management/organization-login/app-native-authentication.md` at line 3, Replace the placeholder comment in app-native-authentication.md with complete documentation: remove the "<!-- TODO: Add content -->" and add an overview of native authentication, prerequisites, step-by-step setup instructions, required configuration fields (example config keys and values), sample code snippets or CLI commands for integration, common troubleshooting tips, and links to related guides; ensure the document uses the existing heading structure and examples consistent with other organization-management guides so readers can follow end-to-end, and if substantive work remains, create an issue referencing this document name to track completion.en/includes/guides/organization-management/organization-login/migrate-organization-login.md (1)
3-3: Complete the documentation content.This page contains only a placeholder comment and provides no guidance to users.
Do you want me to open an issue to track completion of this documentation?
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-management/organization-login/migrate-organization-login.md` at line 3, The file contains only a placeholder <!-- TODO: Add content --> for the migrate-organization-login.md guide; replace that placeholder with complete documentation covering: a short summary of the migration purpose, prerequisites and permissions, step-by-step migration procedure (including required config changes, API/CLI commands and expected responses), rollback/validation steps and common troubleshooting tips, and links to related guides and support channels; ensure the document title and headings reflect "Migrate Organization Login", include examples and exact config keys or command names used during migration, and add a final checklist and contact info for escalation.en/identity-server/next/mkdocs.yml (1)
900-900: Align nav label style with existing “App-native authentication” wording.Line 900 uses
App Native Authentication, while the main Authentication section usesApp-native authentication(Line 694). Consider using one consistent label style across nav for UX/search consistency.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/mkdocs.yml` at line 900, The nav label string "App Native Authentication" in mkdocs nav should be changed to match the existing style "App-native authentication" for consistency; locate the nav entry that references guides/organization-management/organization-login/app-native-authentication.md (currently labeled "App Native Authentication") and rename it to "App-native authentication" so it matches the label used elsewhere (e.g., the Authentication section label "App-native authentication").
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@en/includes/guides/organization-management/organization-login/app-native-authentication.md`:
- Line 1: The document heading "App Native Authentication for organizations"
should use sentence case; update the heading text (the top-line string) to "App
native authentication for organizations" so only the first word is capitalized
and proper nouns (none here) remain unchanged.
In
`@en/includes/guides/organization-management/organization-login/legacy-approach.md`:
- Line 4: The include references missing Jinja variables product_name and
base_path; add definitions for {% set product_name %} and {% set base_path %} in
the wrapper that loads this include (define product_name as "WSO2 Identity
Server" and base_path as "/guides/organization-management/organization-login"),
and remove the <!-- TODO: Add content --> placeholder from the include once real
content is added so the template variables are resolved and no TODO remains.
---
Nitpick comments:
In `@en/identity-server/next/mkdocs.yml`:
- Line 900: The nav label string "App Native Authentication" in mkdocs nav
should be changed to match the existing style "App-native authentication" for
consistency; locate the nav entry that references
guides/organization-management/organization-login/app-native-authentication.md
(currently labeled "App Native Authentication") and rename it to "App-native
authentication" so it matches the label used elsewhere (e.g., the Authentication
section label "App-native authentication").
In
`@en/includes/guides/organization-management/organization-login/app-native-authentication.md`:
- Line 3: Replace the placeholder comment in app-native-authentication.md with
complete documentation: remove the "<!-- TODO: Add content -->" and add an
overview of native authentication, prerequisites, step-by-step setup
instructions, required configuration fields (example config keys and values),
sample code snippets or CLI commands for integration, common troubleshooting
tips, and links to related guides; ensure the document uses the existing heading
structure and examples consistent with other organization-management guides so
readers can follow end-to-end, and if substantive work remains, create an issue
referencing this document name to track completion.
In
`@en/includes/guides/organization-management/organization-login/legacy-approach.md`:
- Line 6: The file
en/includes/guides/organization-management/organization-login/legacy-approach.md
currently contains only a placeholder HTML comment; replace that placeholder by
adding full documentation for the legacy organization login approach in this
file (legacy-approach.md), including: a concise overview of the legacy flow,
step-by-step instructions for users who still use the legacy login, migration
guidance to the new login process, important security considerations, common
troubleshooting Q&A, and links to related docs and APIs; remove the "<!-- TODO:
Add content -->" comment and ensure headings, examples, and any CLI/URL snippets
are accurate and consistent with existing docs conventions.
In
`@en/includes/guides/organization-management/organization-login/migrate-organization-login.md`:
- Line 3: The file contains only a placeholder <!-- TODO: Add content --> for
the migrate-organization-login.md guide; replace that placeholder with complete
documentation covering: a short summary of the migration purpose, prerequisites
and permissions, step-by-step migration procedure (including required config
changes, API/CLI commands and expected responses), rollback/validation steps and
common troubleshooting tips, and links to related guides and support channels;
ensure the document title and headings reflect "Migrate Organization Login",
include examples and exact config keys or command names used during migration,
and add a final checklist and contact info for escalation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 9b033f29-ebc9-439f-8029-5d507b94b662
📒 Files selected for processing (9)
en/identity-server/next/docs/guides/organization-management/organization-login/app-native-authentication.mden/identity-server/next/docs/guides/organization-management/organization-login/index.mden/identity-server/next/docs/guides/organization-management/organization-login/legacy-approach.mden/identity-server/next/docs/guides/organization-management/organization-login/migrate-organization-login.mden/identity-server/next/mkdocs.ymlen/includes/guides/organization-management/organization-login/app-native-authentication.mden/includes/guides/organization-management/organization-login/index.mden/includes/guides/organization-management/organization-login/legacy-approach.mden/includes/guides/organization-management/organization-login/migrate-organization-login.md
| @@ -0,0 +1,3 @@ | |||
| # App Native Authentication for organizations | |||
Contributor
There was a problem hiding this comment.
Apply sentence case to the heading.
The title uses "App Native Authentication" but coding guidelines require sentence case for all headings, capitalizing only the first word and proper nouns. As per coding guidelines: "Use sentence case for all headings and document titles, capitalizing only the first word and proper nouns".
📝 Suggested fix
-# App Native Authentication for organizations
+# App native authentication for organizations📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| # App Native Authentication for organizations | |
| # App native authentication for organizations |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/includes/guides/organization-management/organization-login/app-native-authentication.md`
at line 1, The document heading "App Native Authentication for organizations"
should use sentence case; update the heading text (the top-line string) to "App
native authentication for organizations" so only the first word is capitalized
and proper nouns (none here) remain unchanged.
| # Organization login - legacy approach | ||
|
|
||
| !!! warning "Legacy approach" | ||
| This guide describes the **federation-based organization login** approach used in older versions of {{ product_name }}. For new implementations, use the [enhanced organization authentication]({{base_path}}/guides/organization-management/organization-login/) approach instead. |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if product_name and base_path are set in other wrapper files or globally available
echo "=== Checking wrapper files that set product_name or base_path ==="
rg -n "set (product_name|base_path)" --type=md -g '**/docs/**/*.md' -C2
echo ""
echo "=== Checking if variables are used in other include files ==="
rg -n "{{ ?(product_name|base_path)" --type=md -g '**/includes/**/*.md' | head -20
echo ""
echo "=== Checking MkDocs config for global variables ==="
fd -t f "mkdocs.yml" --exec grep -H "extra:" -A10 {}Repository: wso2/docs-is
Length of output: 50490
🏁 Script executed:
# Check the wrapper file for legacy-approach.md
echo "=== Wrapper file ==="
cat en/identity-server/next/docs/guides/organization-management/organization-login/legacy-approach.md
echo ""
echo "=== Include file ==="
cat en/includes/guides/organization-management/organization-login/legacy-approach.mdRepository: wso2/docs-is
Length of output: 668
Set product_name and base_path template variables in the wrapper file.
The include file references {{ product_name }} and {{base_path}}, but the wrapper file at en/identity-server/next/docs/guides/organization-management/organization-login/legacy-approach.md only defines host_name and organization_path_param. Add the missing variable definitions:
{% set product_name = "WSO2 Identity Server" %}
{% set base_path = "/guides/organization-management/organization-login" %}Also remove the <!-- TODO: Add content --> placeholder in the include file once content is added.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/includes/guides/organization-management/organization-login/legacy-approach.md`
at line 4, The include references missing Jinja variables product_name and
base_path; add definitions for {% set product_name %} and {% set base_path %} in
the wrapper that loads this include (define product_name as "WSO2 Identity
Server" and base_path as "/guides/organization-management/organization-login"),
and remove the <!-- TODO: Add content --> placeholder from the include once real
content is added so the template variables are resolved and no TODO remains.
SujanSanjula96
force-pushed
the
enhanced-b2b-login
branch
from
9fb55ca to
b5a8165
Compare
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
en/includes/guides/organization-management/organization-login/index.md (1)
12-12: Address the TODO comment.The comment indicates a missing screenshot for the Shared Access tab. This visual aid would help users verify the Enhanced Organization Authentication toggle.
Would you like me to open a new issue to track adding this screenshot, or can you confirm the screenshot will be added before merging?
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-management/organization-login/index.md` at line 12, Remove the TODO and add the missing screenshot of the Shared Access tab that clearly shows the Enhanced Organization Authentication toggle (or, if you cannot add the image now, create a tracking issue and reference it in place of the TODO); locate the TODO comment in the organization-login index content where the Shared Access screenshot is referenced and replace it with the embedded image markup and alt text describing the Enhanced Organization Authentication toggle, or replace the TODO with a brief note linking to the newly created issue so reviewers know the screenshot will be added before/after merge.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@en/includes/guides/organization-management/organization-login/index.md`:
- Line 12: Remove the TODO and add the missing screenshot of the Shared Access
tab that clearly shows the Enhanced Organization Authentication toggle (or, if
you cannot add the image now, create a tracking issue and reference it in place
of the TODO); locate the TODO comment in the organization-login index content
where the Shared Access screenshot is referenced and replace it with the
embedded image markup and alt text describing the Enhanced Organization
Authentication toggle, or replace the TODO with a brief note linking to the
newly created issue so reviewers know the screenshot will be added before/after
merge.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: f5143a23-bbe8-4089-88fd-fa4f44e3f405
📒 Files selected for processing (1)
en/includes/guides/organization-management/organization-login/index.md
SujanSanjula96
force-pushed
the
enhanced-b2b-login
branch
from
b5a8165 to
290867e
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
en/includes/guides/organization-management/organization-login/legacy-approach.md (1)
6-6:⚠️ Potential issue | 🟡 MinorRemove unresolved TODO placeholder before merge.
Line 6 still contains a placeholder comment with no actionable content. Replace it with finalized documentation or remove it to avoid publishing incomplete guidance.
As per coding guidelines, “no unverified claims, placeholders, or sensitive data appear in examples.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-management/organization-login/legacy-approach.md` at line 6, Replace the HTML placeholder comment "<!-- TODO: Add content -->" in legacy-approach.md (the unresolved TODO on line containing that string) with finalized documentation or fully remove it; if replacing, provide the actual organization-login legacy guidance content and ensure there are no unverified claims, placeholders, or sensitive data in the new text to satisfy the publishing guidelines.
🧹 Nitpick comments (1)
en/includes/guides/organization-management/organization-login/index.md (1)
6-15: Use one canonical feature name consistently across this page.This page mixes
enhanced organization authenticationandEnhanced Organization Authentication. Pick one official form and use it throughout for the same concept.As per coding guidelines, “Use official product and feature names exactly as defined” and “Use one term per concept.”
Also applies to: 74-76
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-management/organization-login/index.md` around lines 6 - 15, Pick one canonical feature name and use it consistently across the page: replace all occurrences of the lowercase phrase "enhanced organization authentication" with the official title-cased "Enhanced Organization Authentication" (or vice versa if the product doc standard requires lowercase) so headings, inline text, and links use the same exact string; update the instances shown in the diff (the paragraph that references the Shared Access tab) and the other occurrences mentioned (the occurrences around the 74-76 area) so the page only uses the single chosen form for the feature name.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/includes/guides/organization-management/organization-login/index.md`:
- Line 71: Remove the extra blank line causing MD012 by deleting one of the
consecutive empty lines immediately before the "## What's next" section header
in organization-login/index.md so only a single blank line remains directly
above the "## What's next" heading.
- Line 12: Replace the TODO screenshot placeholder in the "Shared Access"
section that references the "Enhanced Organization Authentication toggle" by
either (A) adding the final approved screenshot image and updating the alt
text/caption to avoid any sensitive data, or (B) removing the placeholder
entirely and replacing it with a short textual description of the UI state and
steps to find the toggle; ensure the file content (index.md) contains no
unverified claims or placeholders and that the image/description accurately
matches the UI.
---
Duplicate comments:
In
`@en/includes/guides/organization-management/organization-login/legacy-approach.md`:
- Line 6: Replace the HTML placeholder comment "<!-- TODO: Add content -->" in
legacy-approach.md (the unresolved TODO on line containing that string) with
finalized documentation or fully remove it; if replacing, provide the actual
organization-login legacy guidance content and ensure there are no unverified
claims, placeholders, or sensitive data in the new text to satisfy the
publishing guidelines.
---
Nitpick comments:
In `@en/includes/guides/organization-management/organization-login/index.md`:
- Around line 6-15: Pick one canonical feature name and use it consistently
across the page: replace all occurrences of the lowercase phrase "enhanced
organization authentication" with the official title-cased "Enhanced
Organization Authentication" (or vice versa if the product doc standard requires
lowercase) so headings, inline text, and links use the same exact string; update
the instances shown in the diff (the paragraph that references the Shared Access
tab) and the other occurrences mentioned (the occurrences around the 74-76 area)
so the page only uses the single chosen form for the feature name.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 6cca4b39-07ea-41f2-b7a9-358442dd80eb
📒 Files selected for processing (2)
en/includes/guides/organization-management/organization-login/index.mden/includes/guides/organization-management/organization-login/legacy-approach.md
| 2. Go to the **Shared Access** tab. | ||
| 3. Check whether **Enhanced Organization Authentication** is enabled. | ||
|
|
||
| <!-- TODO: Add screenshot of the Shared Access tab showing the Enhanced Organization Authentication toggle --> |
Contributor
There was a problem hiding this comment.
Replace TODO screenshot placeholder with final content or remove it.
Line 12 leaves incomplete documentation in a user-facing guide.
As per coding guidelines, “no unverified claims, placeholders, or sensitive data appear in examples.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/guides/organization-management/organization-login/index.md` at
line 12, Replace the TODO screenshot placeholder in the "Shared Access" section
that references the "Enhanced Organization Authentication toggle" by either (A)
adding the final approved screenshot image and updating the alt text/caption to
avoid any sensitive data, or (B) removing the placeholder entirely and replacing
it with a short textual description of the UI state and steps to find the
toggle; ensure the file content (index.md) contains no unverified claims or
placeholders and that the image/description accurately matches the UI.
|
|
||
| --- | ||
|
|
||
|
|
Contributor
There was a problem hiding this comment.
Fix markdownlint blocker (MD012) by removing the extra blank line.
Line 71 introduces consecutive blank lines, and the pipeline is already failing on this. Keep only a single blank line before ## What's next.
🧰 Tools
🪛 GitHub Actions: Markdown Lint
[error] 71-71: markdownlint-cli2: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2].
🪛 GitHub Check: lint
[failure] 71-71: Multiple consecutive blank lines
en/includes/guides/organization-management/organization-login/index.md:71 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/guides/organization-management/organization-login/index.md` at
line 71, Remove the extra blank line causing MD012 by deleting one of the
consecutive empty lines immediately before the "## What's next" section header
in organization-login/index.md so only a single blank line remains directly
above the "## What's next" heading.
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
1 participant
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.
Purpose