Skip to content

Conversation

@wso2-engineering-bot
Copy link

@wso2-engineering-bot wso2-engineering-bot commented Dec 5, 2025

This PR was automatically generated by Claude AI.

  • Issue: [Docs] Missing document on how to show/hide Cookie Consent Banner with Configurations product-is#25846
  • Type: Documentation (Missing Information)
  • Summary: Added comprehensive documentation for configuring the cookie consent banner in WSO2 Identity Server, including global configuration and per-application settings for Console and MyAccount portals.
  • Affected Versions: 7.0.0, 7.1.0, 7.2.0, next
  • Style Scope Verification: This PR creates entirely new documentation. The complete document has been written following Microsoft Style Guide standards, including proper heading structure (sentence case), active voice, clear procedural steps, appropriate use of notes and tips, and consistent formatting for code blocks and configuration examples.
  • Verification: mkdocs build passed successfully for all affected versions (7.0.0, 7.1.0, 7.2.0, next)

Changes included

New documentation file

  • Created en/includes/guides/branding/configure-cookie-consent-banner.md as a common template
  • Added version-specific files in en/identity-server/{version}/docs/guides/branding/configure-cookie-consent-banner.md for:
    • 7.0.0
    • 7.1.0
    • 7.2.0
    • next

Updated branding index

  • Updated en/includes/guides/branding/index.md to include a link to the new cookie consent banner configuration guide

Documentation content

The new documentation explains:

  1. How to disable the cookie consent banner globally using [ui.cookie_consent_banner] configuration
  2. How to disable the banner per application for Console and MyAccount using [console.ui] and [myaccount.ui] configurations
  3. Configuration priority and behavior
  4. Multiple example configurations for different use cases

Build verification

All affected versions were successfully built and verified:

  • ✅ Version 7.0.0: Build successful
  • ✅ Version 7.1.0: Build successful
  • ✅ Version 7.2.0: Build successful
  • ✅ Version next: Build successful

Resolves wso2/product-is#25846

Summary by CodeRabbit

  • Documentation
    • Added comprehensive cookie consent banner documentation page across Identity Server versions 7.0.0, 7.1.0, and 7.2.0
    • Documentation guides users through deployment and configuration of cookie consent functionality
    • Pages integrated into product navigation under the Configure section for easy discovery and access

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

…l affected versions (product-is#25846)

This PR adds comprehensive documentation for configuring the cookie consent banner
in WSO2 Identity Server. The documentation covers:

- Global configuration to enable/disable the banner across all applications
- Per-application configuration for Console and MyAccount portals
- Configuration priority and examples

Versions updated:
- 7.0.0
- 7.1.0
- 7.2.0
- next

Resolves wso2/product-is#25846
@CLAassistant
Copy link

CLAassistant commented Dec 5, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ himeshsiriwardana
❌ wso2-engineering-bot


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
Copy link

coderabbitai bot commented Dec 5, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation for the Cookie Consent Banner configuration feature is added across three Identity Server versions (7.0.0, 7.1.0, 7.2.0). Each version includes a new markdown page that incorporates shared content and updates the navigation configuration to expose the new documentation page.

Changes

Cohort / File(s) Summary
Version 7.0.0 Documentation
en/identity-server/7.0.0/docs/deploy/configure/cookie-consent-banner.md, en/identity-server/7.0.0/mkdocs.yml
Adds new cookie consent banner documentation page with include directive; updates navigation under Get Started/Guides section to reference the new page.
Version 7.1.0 Documentation
en/identity-server/7.1.0/docs/deploy/configure/cookie-consent-banner.md, en/identity-server/7.1.0/mkdocs.yml
Introduces cookie consent banner documentation page with include directive; adds navigation entry under Configure section alongside Clock tolerance.
Version 7.2.0 Documentation
en/identity-server/7.2.0/docs/deploy/configure/cookie-consent-banner.md, en/identity-server/7.2.0/mkdocs.yml
Creates cookie consent banner documentation page with include directive; adds navigation item under deploy/configure section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A banner for cookies, now documented with care,
Spread through three versions, quite fair, quite fair!
Configuration secrets revealed and displayed,
Three docs, one content—reusable, well-made! 🍪✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding documentation for cookie consent banner configuration across multiple versions.
Description check ✅ Passed The description provides comprehensive context about the changes, including issue reference, affected versions, and verification steps, but deviates from the template by not filling key sections.
Linked Issues check ✅ Passed The PR successfully implements all coding requirements from issue #25846: documents global cookie consent banner control via [ui.cookie_consent_banner], per-application control via [console.ui] and [myaccount.ui], clarifies configuration scope, and provides examples.
Out of Scope Changes check ✅ Passed All changes are directly aligned with the linked issue requirements. The PR only adds documentation for cookie consent banner configuration and updates the branding index accordingly.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8d756b and 97dedaf.

📒 Files selected for processing (6)
  • en/identity-server/7.0.0/docs/deploy/configure/cookie-consent-banner.md
  • en/identity-server/7.0.0/mkdocs.yml
  • en/identity-server/7.1.0/docs/deploy/configure/cookie-consent-banner.md
  • en/identity-server/7.1.0/mkdocs.yml
  • en/identity-server/7.2.0/docs/deploy/configure/cookie-consent-banner.md
  • en/identity-server/7.2.0/mkdocs.yml

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.

@himeshsiriwardana himeshsiriwardana merged commit d0f5a19 into master Jan 5, 2026
1 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Missing document on how to show/hide Cookie Consent Banner with Configurations

4 participants