Fix: Add comprehensive testing guide for invite user to set password feature for all affected versions (Product IS issue #25317) #5750
Conversation
…feature for all affected versions (product-is#25317) - Added detailed step-by-step instructions for inviting users to set passwords - Included admin-triggered resend invitation functionality (via console and API) - Added complete user experience flow for both email link and OTP methods - Enhanced documentation to match the comprehensive structure of self-registration docs - Applied changes to versions 7.0.0, 7.1.0, 7.2.0, and next (7.2.0-alpha) - All new content follows Microsoft Style Guide 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
|
wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
WalkthroughDocumentation files for Identity Server versions 7.0.0, 7.1.0, 7.2.0, and next have been updated with template variable definitions for host configuration. The shared include file for user onboarding has been comprehensively rewritten with detailed tutorial content, API examples, and user experience workflows. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
en/includes/guides/account-configurations/user-onboarding/invite-user-to-set-password.md (1)
83-105: Minor wording improvement suggested: "Try out" section heading.Line 83 reads "## Try out invite user to set password" which is grammatically awkward. Consider revising to one of these alternatives:
- "## Test the feature"
- "## Hands-on guide"
- "## Password setup workflows"
- "## End-to-end user onboarding"
This is a minor refinement to improve readability and align with documentation style conventions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
en/identity-server/7.0.0/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md(1 hunks)en/identity-server/7.1.0/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md(1 hunks)en/identity-server/7.2.0/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md(1 hunks)en/identity-server/next/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md(1 hunks)en/includes/guides/account-configurations/user-onboarding/invite-user-to-set-password.md(1 hunks)
🔇 Additional comments (9)
en/identity-server/next/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md (1)
5-7: Consistent with other versioned files.The template variable definitions and include path follow the same pattern as the 7.0.0, 7.1.0, and 7.2.0 files. The search exclusion front matter is appropriate for preview documentation. Concerns about host_name values apply equally to this file (see review of en/identity-server/7.0.0/...).
en/identity-server/7.2.0/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md (1)
5-7: Consistent pattern across version files.Follows the same template variable and include structure as other versioned documentation files. See host_name verification request in the 7.0.0 file review.
en/identity-server/7.1.0/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md (1)
1-3: Consistent with other version files.Follows the standard template variable definition pattern. Host_name verification applies here as well (see 7.0.0 review).
en/includes/guides/account-configurations/user-onboarding/invite-user-to-set-password.md (5)
130-130: Verify the API endpoint link is accurate and current.Line 130 references the API documentation path:
{{base_path}}/apis/use-the-self-sign-up-rest-apis/#tag/Self-Register/paths/~1resend-code/post.Confirm that:
- This path exists in the published API documentation
- The endpoint is named/tagged consistently across all versions (7.0.0, 7.1.0, 7.2.0)
- The fragment identifier
#tag/Self-Register/paths/~1resend-code/postis correct
9-9: Verify version comparison logic for string-based version checking.Lines 9 and 38 use the Jinja2 conditional
is_version > "7.1.0"for version-based content switching. Verify that:
- The
is_versionvariable is properly injected into the Jinja2 context by the MkDocs build system- Version string comparison works as expected (e.g., "7.2.0" > "7.1.0" and "7.1.0-alpha" handling)
- The comparison logic correctly gates content for older versions (7.0.0, 7.1.0 vs. 7.2.0, next)
If version strings use non-numeric suffixes (e.g., "-alpha", "-beta"), consider using explicit version lists instead of comparison operators to avoid string-ordering edge cases.
Also applies to: 38-38
139-139: Verify template variable scope and availability in included files.Lines 139 and 158 reference
{{ host_name }}and{{ host_name_example }}, which are defined in the parent version-specific files (lines 1-2 of each version file).Confirm that:
- MkDocs/Jinja2 correctly propagates these variables from the parent template to the included file
- Variables are accessible in the context when the include directive is processed
- All version files (7.0.0, 7.1.0, 7.2.0, next) correctly define these variables before the include statement
If variable scope is not guaranteed, consider defining these variables at the top of the shared include file itself, or use environment-specific substitution at build time.
Also applies to: 158-158
133-177: API examples use template variables appropriately.The curl request examples at lines 133–177 correctly parameterize the hostname using
{{ host_name }}and{{ host_name_example }}with distinct tabs for "Request format" and "Sample request". This is good practice for showing both the template pattern and a concrete example.Ensure that the response format (HTTP 201 Created at line 177) is accurate for the Resend Code API endpoint.
182-241: Comprehensive user experience documentation is well-structured.The "User experience flow" section (lines 182–241) provides clear, step-by-step guidance for both email-link and OTP-based password setup, including:
- Initial invitation receipt
- Browser/email interactions
- Password entry and confirmation
- Success confirmations
- Account activation notifications
- End-user login capability
The two OTP options ("Using the password recovery endpoint" vs. "Using basic authentication") are clearly differentiated. The final note about expiry, account lock behavior, and error recovery is helpful.
en/identity-server/7.0.0/docs/guides/account-configurations/user-onboarding/invite-user-to-set-password.md (1)
1-3: No action required. WSO2 Identity Server 7.0.0 uses port 9443 as its default HTTPS management port, confirming thehost_nameandhost_name_examplevalues in the file are correct.
This PR was automatically generated by Claude AI.
Invite user to set passworddoc does not include how to test this feature product-is#25317Changes Made
Added Content
Technical Details
en/includes/guides/account-configurations/user-onboarding/invite-user-to-set-password.mdAffected Versions
All versions with the invite user to set password feature:
Style Compliance
Verification
mkdocs build --strictcompleted successfullyReferences
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.