cleanhouse: refine the document structure (#172)

[IceCodeNew]

• cleanhouse: refine the document structure

• fix: words not very accurate

Summary by CodeRabbit

• Documentation
  • Clarified standby cluster guidance by standardizing the admin user term.
  • Reorganized pre-upgrade guide: promoted Prerequisites, streamlined notes, and introduced a Tabs layout.
  • Updated requirements: Kubernetes 1.30+; Istio 1.22+; at least 120 GB free on the global control plane; 250 GB for package extraction.
  • Added inline reminder to verify supported upgrade paths before upgrading.
  • Added an “Upgrading from 3.18” tab highlighting that CostManager/Kubecost plugins must not be installed.
  • Improved readability and structure.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Two docs updated: a minor wording change in Global DR install instructions to use a term placeholder, and a significant reorganization of the pre-upgrade guide, including heading/section restructuring, Tabs UI, prerequisite table edits, and updated notes on versions and storage.

Changes

Cohort / File(s)	Summary
Global DR wording update docs/en/install/global_dr.mdx	Replaced explicit admin user name with <Term name="productShort" /> in a credentials note for standby cluster installation. No other edits.
Pre-upgrade doc reorganization and updates docs/en/upgrade/pre-upgrade.mdx	Restructured sections (promoted Prerequisites to H2, removed standalone Important Notes), added Tabs UI (“Upgrading from 3.18”), revised wording, updated supported-upgrade reminder inline, adjusted prerequisite table (Kubernetes ≥1.30, Istio ≥1.22, GCP disk space 120 GB, package extraction 250 GB), and reorganized notes including Kubernetes 1.31+ Pod restart behavior and DR upgrade procedure context.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• [upgrade doc]: prerequisite of ACP v4.1 #52 — Also edits pre-upgrade.mdx, overlapping on supported upgrade-paths and package wording.
• [upgrade-doc]:least k8s version before upgrading #57 — Aligns minimum Kubernetes version to 1.30 in pre-upgrade.mdx.
• feat: introduce FAQ for installation of Global DR #157 — Touches global_dr.mdx with broader Global DR steps and credential guidance.

Suggested reviewers

• fanzy618

Poem

Thump-thump! I hop through docs so bright,
Tabs appear, prerequisites set right.
A tiny term swaps in—so neat!
Versions checked, upgrades complete.
With whiskers twitching, I approve—
Carrots for clean, well-ordered move. 🥕✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 4663801 and ef1d3c7.

📒 Files selected for processing (2)

• docs/en/install/global_dr.mdx (1 hunks)
• docs/en/upgrade/pre-upgrade.mdx (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch upgrade-doc-4.1

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.