Fix: Update push provider documentation to include extension mechanism for all affected versions (Product IS issue #26443)

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

Issue: wso2/product-is#26443

Type: Documentation

Summary: Updated the push provider documentation to reflect that WSO2 Identity Server 7.1.0 and later versions support configuring any push provider as an extension, not just Firebase Cloud Messaging (FCM). The documentation now includes information about the extension mechanism for custom push providers, support for multiple active push providers, and how devices can specify which provider to use during registration.

Affected Versions: 7.1.0, 7.2.0, and next

All three versions use the same include file at en/includes/guides/notification-channels/configure-push-provider.md, so a single change updates all affected versions.

Changes Made:

• Updated introduction to clarify FCM is the default push notification provider (not the only one)
• Added new section "Configure custom push providers" with comprehensive information about:
  • Extension mechanism for implementing custom push providers
  • Support for multiple active push providers simultaneously
  • Device registration with specific push provider selection
  • Real-world examples (e.g., HMS Push Kit for Huawei devices)
• Reorganized content with clearer section headings following Microsoft Style Guide
• Added prerequisites section for custom push provider implementation
• Added implementation steps for configuring custom push providers as extensions
• Included security and best practices recommendations

Style Scope Verification: Microsoft Style Guidelines have been applied ONLY to newly added content without modifying existing content style unless specifically requested.

Verification:

• Documentation builds successfully with mkdocs build
• The generated HTML contains the new custom push provider content
• All affected versions (7.1.0, 7.2.0, next) will receive the update through the shared include file

Summary by CodeRabbit

• Documentation
  • Clarified default push provider configuration guidance
  • Added comprehensive custom push provider setup instructions
  • Expanded support for devices without Google Play Services
  • Improved documentation structure with enhanced security best practices

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

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.}

[coderabbitai]

Walkthrough

This pull request updates documentation for push provider configuration by restructuring content, correcting terminology (Firebase Cloud Messaging, APNs), establishing FCM as the default provider, and adding a comprehensive guide for custom push provider extensions with support for alternative device services.

Changes

Cohort / File(s)

Summary

Push Provider Configuration Documentation en/includes/guides/notification-channels/configure-push-provider.md

Restructured push provider configuration guide with explicit FCM default, corrected terminology capitalization, separated FCM and custom provider configuration flows, added comprehensive custom push provider extension guide including mechanism, prerequisites, implementation, multi-provider enablement, testing, and security considerations, expanded guidance for non-Google Play Services devices (HMS Push Kit).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Single documentation file with structural reorganization and content additions
• Focus review on: terminology accuracy and consistency (Firebase Cloud Messaging, APNs), clarity of new custom provider extension guidance, completeness of prerequisites and implementation steps, accuracy of security recommendations

Poem

🐰 A push through the docs, so clear and so bright,
FCM defaults now shine in the light,
Custom extensions bloom in each fold,
Hopping through channels, our story retold! 📬✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description provides comprehensive details about the changes, but does not follow the required template with Purpose, Related PRs, Test environment, and Security checks sections.	Reformat the description to follow the repository template: add Purpose section with issue link, Related PRs section, Test environment details, and Security checks checklist.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately reflects the main change: updating push provider documentation to include the extension mechanism for multiple versions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fixing-product-is-issue-26443-1765859866

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

en/includes/guides/notification-channels/configure-push-provider.md (2)

5-7: Clarify the APNs configuration requirement.

Line 6 states FCM "has the capability to send push notifications to iOS devices through Apple Push Notification Service (APNs)" but then says "you need to configure APNs separately." This could imply a contradiction—consider rephrasing to clarify that APNs credentials must be configured separately even though FCM can send through APNs.

For example: "FCM can relay push notifications to iOS through APNs, but you must configure APNs credentials separately in Firebase to enable this capability."

---

49-68: Implementation steps could benefit from more concrete guidance.

Lines 49–68 provide high-level steps but lack detail on:

• The specific interface or contract custom providers must implement
• Concrete example of "push provider identifier" format and how it flows during device registration (referenced in line 64)
• Where/how to register the extension in {{ product_name }} deployment

Consider linking to a reference implementation or code example, even if minimal. If these details are intentionally deferred to the "extension development documentation" (line 74), ensure that cross-reference is discoverable to users.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f09eb0 and 8a03a3f.

📒 Files selected for processing (1)

• en/includes/guides/notification-channels/configure-push-provider.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

en/includes/guides/notification-channels/configure-push-provider.md

[style] ~72-~72: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 3770 characters long)
Context: ... and proper validation of push tokens. !!! note For detailed guidance on imple...

(EN_EXCESSIVE_EXCLAMATION)

🔇 Additional comments (2)

en/includes/guides/notification-channels/configure-push-provider.md (2)

1-24: Clear restructuring and terminology fixes.

The restructuring to separate FCM configuration into its own section and the terminology corrections (Firebase Cloud Messaging, APNs) improve clarity and accuracy. Line 3's clarification that FCM is the default provider—not the only option—sets proper context for the new custom provider section.

---

25-75: Comprehensive custom provider guidance with good real-world context.

The new section effectively explains the extension mechanism, prerequisites, and implementation steps. The HMS Push Kit example (line 27) is helpful and concrete. Security considerations (line 71) and reference to version-specific extension docs (line 74) are appropriate for a guide-level reference.