Skip to content

Clarify that branding revert applies to the whole configuration, not individual fields#6248

Open
BimsaraBodaragama wants to merge 1 commit into
wso2:masterfrom
BimsaraBodaragama:fix-28091/branding-revert-whole-config-note
Open

Clarify that branding revert applies to the whole configuration, not individual fields#6248
BimsaraBodaragama wants to merge 1 commit into
wso2:masterfrom
BimsaraBodaragama:fix-28091/branding-revert-whole-config-note

Conversation

@BimsaraBodaragama

Copy link
Copy Markdown
Member

Purpose

Clarifies the UI branding inheritance guide to make explicit that reverting branding restores inherited values for the entire configuration saved at a level (via Revert to default), not for an individual field in isolation. Clearing a single field's value (e.g. the Logo URL) and saving does not cause that field alone to inherit — the level's customization stays in effect with that field left empty.

Related to wso2/product-is#28091, where a customer expected clearing an individual field to trigger inheritance for that field.

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Changes

UI branding inheritance

Layer / File(s) Summary
Clarify branding revert behavior
en/includes/guides/organization-management/inheritance-in-organizations/ui-branding-inheritance.md
Documents that reverting restores the full saved branding configuration, while clearing and saving an individual field does not re-enable inheritance. Includes a link to the “Revert to default” guide.

Suggested labels: Team/Identity Server Core

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The purpose is clear, but the template's Related PRs, Test environment, and Security checks sections are missing. Add the required Related PRs, Test environment, and Security checks sections, or explicitly note any unavailable details.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title accurately summarizes the main doc change about branding revert behavior.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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/organization-management/inheritance-in-organizations/ui-branding-inheritance.md`:
- Around line 41-48: Rewrite the individual-field limitation in the note
beginning “Reverting applies to the whole configuration...” using active voice:
replace “an individual setting ... cannot be reverted on its own” with wording
such as “You cannot revert an individual setting on its own,” while preserving
the surrounding meaning and guidance.
🪄 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: fe7043ac-cbcb-4142-8dc3-0b3e6352659d

📥 Commits

Reviewing files that changed from the base of the PR and between a90d190 and 6099ee4.

📒 Files selected for processing (1)
  • en/includes/guides/organization-management/inheritance-in-organizations/ui-branding-inheritance.md

Comment on lines +41 to +48
!!! note "Reverting applies to the whole configuration, not individual fields"
Reverting restores inherited values for the **entire** branding customization saved at
that level — an individual setting (for example, just the logo) cannot be reverted on
its own. Clearing the value of a single field and saving does not cause that field to
inherit from the parent level; the level's customization remains in effect with that
field left empty. To restore inheritance, use **Revert to default**, as described in
[Configure UI branding]({{base_path}}/guides/branding/configure-ui-branding/#revert-branding).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use active voice for the individual-field limitation.

Replace “an individual setting ... cannot be reverted on its own” with direct wording such as “You cannot revert an individual setting on its own.” This keeps the note concise and follows the documentation requirement to prefer active voice.

Suggested wording
-    that level — an individual setting (for example, just the logo) cannot be reverted on
-    its own. Clearing the value of a single field and saving does not cause that field to
+    that level — you cannot revert an individual setting (for example, just the logo) on
+    its own. Clearing the value of a single field and saving does not cause that field to
📝 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
!!! note "Reverting applies to the whole configuration, not individual fields"
Reverting restores inherited values for the **entire** branding customization saved at
that level — an individual setting (for example, just the logo) cannot be reverted on
its own. Clearing the value of a single field and saving does not cause that field to
inherit from the parent level; the level's customization remains in effect with that
field left empty. To restore inheritance, use **Revert to default**, as described in
[Configure UI branding]({{base_path}}/guides/branding/configure-ui-branding/#revert-branding).
!!! note "Reverting applies to the whole configuration, not individual fields"
Reverting restores inherited values for the **entire** branding customization saved at
that level — you cannot revert an individual setting (for example, just the logo) on
its own. Clearing the value of a single field and saving does not cause that field to
inherit from the parent level; the level's customization remains in effect with that
field left empty. To restore inheritance, use **Revert to default**, as described in
[Configure UI branding]({{base_path}}/guides/branding/configure-ui-branding/#revert-branding).
🤖 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/organization-management/inheritance-in-organizations/ui-branding-inheritance.md`
around lines 41 - 48, Rewrite the individual-field limitation in the note
beginning “Reverting applies to the whole configuration...” using active voice:
replace “an individual setting ... cannot be reverted on its own” with wording
such as “You cannot revert an individual setting on its own,” while preserving
the surrounding meaning and guidance.

Source: Coding guidelines

@BimsaraBodaragama

Copy link
Copy Markdown
Member Author

✅ Fix Verification

You can view the update on the page en/next/guides/organization-management/inheritance-in-organizations/ui-branding-inheritance/ at [1].

image

[1] https://is.docs.wso2.com/


- Organizations can also revert their application-specific branding settings, restoring either their organization-wide settings or the inherited values.

!!! note "Reverting applies to the whole configuration, not individual fields"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
!!! note "Reverting applies to the whole configuration, not individual fields"
!!! note "Reverting affects the entire branding configuration"

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.

2 participants