Skip to content

fix: correct url for private data plane#567

Open
Gayuth-W wants to merge 1 commit into
wso2:mainfrom
Gayuth-W:fix/clean-data-plane-url
Open

fix: correct url for private data plane#567
Gayuth-W wants to merge 1 commit into
wso2:mainfrom
Gayuth-W:fix/clean-data-plane-url

Conversation

@Gayuth-W

@Gayuth-W Gayuth-W commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Purpose

The private-date-plane documentation folder is misspelled - it should be private-data-plane. Because these pages have no slug/id frontmatter override and the site uses routeBasePath: '/', the typo is served directly in the public URL. The page title and body content already read "Private Data Plane" correctly; only the URL slug is wrong.

Currently live at the misspelled URL (note "date" instead of "data"):
https://wso2.com/integration-platform/docs/manage/cloud/private-date-plane/overview

Goals

Correct the folder name so the published URL reads /manage/cloud/private-data-plane/..., matching the page content and the spelling used elsewhere in the docs.

This is purely a slug correction - no visible page content changes. Note that it changes the published URL, so the old /private-date-plane/ paths will 404 after merge (see Migrations).

Approach

  • Renamed en/docs/manage/cloud/private-date-plane/en/docs/manage/cloud/private-data-plane/ (3 files, renamed without content changes).
  • Updated the 3 references in en/sidebars.ts to the new path.

User stories

N/A

Release note

Corrected the misspelled URL slug for the Private Data Plane documentation pages (private-date-plane to private-data-plane).

Documentation

N/A - this PR is itself a documentation change. Affected pages:

  • /manage/cloud/private-data-plane/overview
  • /manage/cloud/private-data-plane/management-models
  • /manage/cloud/private-data-plane/security-levels

Training

N/A

Certification

N/A

Marketing

N/A

Automation tests

  • Unit tests: N/A — documentation-only change, no application code.
  • Integration tests: N/A — verified via the Docusaurus build; sidebar references resolve to the renamed paths.

Security checks

  • Followed secure coding standards: N/A - documentation-only change, no code.
  • Ran FindSecurityBugs plugin and verified report: N/A - no Java/application code.
  • Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets: yes.

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

The published URL changes from /manage/cloud/private-date-plane/* to /manage/cloud/private-data-plane/*. Old URLs will 404 after merge.

Test environment

Verified locally

Learning

N/A

Summary by CodeRabbit

  • Bug Fixes
    • Corrected sidebar links for the “Private Data Plane” documentation so they now point to the proper pages.
    • Updated the listed documentation paths to match the current location, improving navigation and reducing broken links.

- changed the folder name from 'private-date-plane' to 'private-data-plane'
- changed the sidebars.ts to match the new file path
@coderabbitai

coderabbitai Bot commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Fixes a typo in en/sidebars.ts where the "Private Data Plane" sidebar category referenced private-date-plane (with "date") instead of private-data-plane in the link and item doc IDs.

Changes

Sidebar Doc ID Typo Fix

Layer / File(s) Summary
Fix private-data-plane path typo
en/sidebars.ts
Corrects three doc ID strings from private-date-plane to private-data-plane in the sidebar link and items entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A date crept in where data should be,
🐇 the rabbit hopped and fixed it with glee!
Three little strings, now spelling right,
the sidebar path shines clear and bright.
No more confusion in the docs tonight! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: correcting the Private Data Plane URL path.
Description check ✅ Passed The PR description matches the template and covers all required sections, with acceptable N/A entries where not applicable.
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.
✨ 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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
en/sidebars.ts (1)

2119-2129: 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Add a redirect for the old docs path
en/docusaurus.config.ts has no redirect setup, so the old private-date-plane URLs will still 404 and break existing bookmarks/search results.

🤖 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/sidebars.ts` around lines 2119 - 2129, The new “Private Data Plane”
sidebar entry is added, but the old `private-date-plane` docs URLs still need a
redirect to avoid 404s. Update the redirect setup in `docusaurus.config.ts` to
map the legacy private-data-plane path to the new
`manage/cloud/private-data-plane/overview` route, and make sure the redirect
covers the old slug so existing bookmarks and search results continue working.
🤖 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.

Outside diff comments:
In `@en/sidebars.ts`:
- Around line 2119-2129: The new “Private Data Plane” sidebar entry is added,
but the old `private-date-plane` docs URLs still need a redirect to avoid 404s.
Update the redirect setup in `docusaurus.config.ts` to map the legacy
private-data-plane path to the new `manage/cloud/private-data-plane/overview`
route, and make sure the redirect covers the old slug so existing bookmarks and
search results continue working.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 539e1d56-fd99-4bb0-816b-ad5f162e7727

📥 Commits

Reviewing files that changed from the base of the PR and between e1e301b and 713772b.

📒 Files selected for processing (4)
  • en/docs/manage/cloud/private-data-plane/management-models.md
  • en/docs/manage/cloud/private-data-plane/overview.md
  • en/docs/manage/cloud/private-data-plane/security-levels.md
  • en/sidebars.ts

@github-actions

Copy link
Copy Markdown

Broken links, images & orphan pages

Passing — no broken links or images found.

Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by sidebars.ts.

Summary

  • Broken links & images — total 0 · 🆕 introduced 0 · 📄 already on main 0
  • Orphan pages — total 8 · 🆕 introduced 0 · 📄 already on main 8

Broken links & images

Introduced by this PR

No new broken link(s)/image(s) introduced by this PR. ✅

Already on main — 0 total

None.

Orphan pages

Introduced by this PR

No new orphan page(s) introduced by this PR. ✅

Already on main — 8 total

Already present on the base branch (not caused by this PR):

Show 8
  • docs/deploy-operate/observe/datadog-integration
  • docs/deploy-operate/observe/elastic-stack-elk
  • docs/deploy-operate/observe/metrics-prometheus-grafana
  • docs/deploy-operate/observe/opensearch-integration
  • docs/deploy-operate/observe/recipe-elk-stack
  • docs/deploy-operate/observe/recipe-kubernetes-production
  • docs/deploy-operate/observe/recipe-local-development
  • docs/deploy-operate/observe/recipe-opensearch-setup

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.

2 participants