Skip to content

Add test connection guide and related images for federated login#6159

Open
LinukaAr wants to merge 2 commits into
wso2:feature-connection-debugfrom
LinukaAr:idp-validator
Open

Add test connection guide and related images for federated login#6159
LinukaAr wants to merge 2 commits into
wso2:feature-connection-debugfrom
LinukaAr:idp-validator

Conversation

@LinukaAr
Copy link
Copy Markdown
Contributor

Purpose

Adds documentation for the Test Connection feature on federated identity provider connections.

Related PRs

Security checks

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 34fdab5c-dede-4827-b798-cb8cc50b06a7

📥 Commits

Reviewing files that changed from the base of the PR and between 421fb0c and 898f1ff.

📒 Files selected for processing (1)
  • en/includes/guides/fragments/manage-connection/test-connection.md
✅ Files skipped from review due to trivial changes (1)
  • en/includes/guides/fragments/manage-connection/test-connection.md

📝 Walkthrough

Walkthrough

This PR adds documentation for testing federated identity connections. A new reusable fragment provides step-by-step test instructions and results interpretation, then is integrated into the federated login guide to extend the setup flow with connection verification.

Changes

Federated Login Test Connection Guide

Layer / File(s) Summary
Test connection fragment
en/includes/guides/fragments/manage-connection/test-connection.md
New documentation fragment introduces the full test connection workflow, covering test initiation, authentication flow, results page tabs (ID Token, Claim Mappings, Diagnosis), and troubleshooting when tests fail.
Federated login guide integration
en/includes/guides/authentication/federated-login/index.md
Federated login guide incorporates the test connection fragment as a new "Test a connection" section to extend the setup flow with connection verification instructions.

Suggested labels

Team/Authentication & registration

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding test connection documentation and related images for federated login, which matches the changeset.
Description check ✅ Passed The description includes the required Purpose and Related PRs sections with appropriate details. Security checks are documented and marked as completed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
en/includes/guides/fragments/manage-connection/test-connection.md (1)

13-14: ⚡ Quick win

Use more direct, active phrasing.

The phrase "Authenticate using a valid account" can be strengthened, and "After a successful authentication" uses passive voice. Consider more direct active voice.

♻️ Proposed improvements
-4. {{ product_name }} redirects you to the federated identity provider's login page. Authenticate using a valid account from that IdP.
-5. After a successful authentication, you are redirected back to {{ product_name }}, and the test results are displayed.
+4. {{ product_name }} redirects you to the federated identity provider's log in page. Enter credentials for a valid account from that IdP.
+5. After you authenticate successfully, {{ product_name }} redirects you back and displays the test results.

Note: Also changed "login page" to "log in page" for consistency with the verb form.

As per coding guidelines: Use active voice and present tense; reduce unnecessary use of weak 'be' verbs and prefer direct verbs.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@en/includes/guides/fragments/manage-connection/test-connection.md` around
lines 13 - 14, Replace passive/weak phrasing in the two sentences: change
"Authenticate using a valid account from that IdP." to an active directive like
"Sign in with a valid account from that IdP." and change "After a successful
authentication, you are redirected back to {{ product_name }}, and the test
results are displayed." to an active present-tense sentence such as "After you
sign in, {{ product_name }} redirects you back and displays the test results."
also prefer "log in page" instead of "login page" in the first sentence.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/includes/guides/fragments/manage-connection/test-connection.md`:
- Around line 7-9: Update the three steps so UI elements are bold: change step 1
to "On the {{ product_name }} Console, go to **Connections**.", change step 2 to
use a direct verb and bold the connection reference like "Select the
**connection you want to test**." (bold the connection name/placeholder), and
change step 3 to "Click **Test Connection** on the connection page." ensuring
**Connections**, the connection name placeholder, and **Test Connection** are
all bolded.

---

Nitpick comments:
In `@en/includes/guides/fragments/manage-connection/test-connection.md`:
- Around line 13-14: Replace passive/weak phrasing in the two sentences: change
"Authenticate using a valid account from that IdP." to an active directive like
"Sign in with a valid account from that IdP." and change "After a successful
authentication, you are redirected back to {{ product_name }}, and the test
results are displayed." to an active present-tense sentence such as "After you
sign in, {{ product_name }} redirects you back and displays the test results."
also prefer "log in page" instead of "login page" in the first sentence.
🪄 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: 1fbf6e8e-e6a2-4914-b2ea-0b618f241f9a

📥 Commits

Reviewing files that changed from the base of the PR and between 391ca5e and 421fb0c.

⛔ Files ignored due to path filters (2)
  • en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-button.png is excluded by !**/*.png
  • en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-results.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • en/includes/guides/authentication/federated-login/index.md
  • en/includes/guides/fragments/manage-connection/test-connection.md

Comment thread en/includes/guides/fragments/manage-connection/test-connection.md Outdated
@LinukaAr LinukaAr changed the base branch from master to feature-connection-debug May 29, 2026 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant