Admin: Relocate "Scale clusters up and down" to parent folder

[amotl]

About

Another little refactoring to prepare dissolving the "Admin/Clustering" section.

[coderabbitai]

Walkthrough

Documentation updates standardizing heading capitalization across administrative guides and reorganizing navigation structure. The toctree in clustering documentation is reorganized by removing a "Scale Clusters" link from one file while adding a corresponding "Scaling" entry in the main admin index.

Changes

Cohort / File(s)	Summary
Heading capitalization standardization docs/admin/circuit-breaker.md, docs/admin/memory.md	Changed heading text to use lowercase after initial word ("Circuit breaker", "Memory configuration")
User management documentation docs/admin/create-user.md	Updated top-level heading from "Create User" to "User management" with formatting adjustment
Navigation reorganization docs/admin/clustering/index.md, docs/admin/index.md	Removed "Scale Clusters" link from clustering toctree and added "Scaling" entry to admin index under Cluster card

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• All changes are documentation-only (headings and toctree entries)
• No logic, code, or functional modifications
• Cosmetic and navigation restructuring

Possibly related PRs

• Sharding and partitioning 101: Relocate to "performance guides" section #467 — Concurrently modifies docs/admin/index.md toctree structure, reorganizing cluster-related navigation entries.

Suggested reviewers

• kneth
• surister
• bmunkholm

Poem

🐰 Headings stand tall, now dressed in grace,
Lowercase letters find their place,
Navigation flows from here to there,
Docs now organized with care! 📚✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "Admin: Relocate 'Scale clusters up and down' to parent folder" refers to a real and significant part of the changeset. The summary confirms that "Scale Clusters" documentation reference has been removed from docs/admin/clustering/index.md and "Scaling" has been added to docs/admin/index.md, which directly matches the relocation described in the title. While the changeset also includes cosmetic heading capitalization changes in several files (circuit-breaker, create-user, and memory), these appear to be secondary modifications supporting the primary structural reorganization that the title accurately captures. The title is clear, concise, and meaningfully describes the main structural change without being overly broad.
Description Check	✅ Passed	The PR description states the intent is "Another little refactoring to prepare dissolving the 'Admin/Clustering' section," which is directly related to the changeset. The changes involve removing the "Scale Clusters" entry from the clustering subsection and relocating it to the parent admin section, which aligns with the goal of dissolving/reorganizing the clustering section. While the description is brief and doesn't elaborate on all the details (heading changes, etc.), it provides meaningful context for the primary purpose of the changeset and is clearly related to what is being modified.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch admin-unfolding-and-titles

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 764fbe7 and de35cb7.

📒 Files selected for processing (5)

• docs/admin/circuit-breaker.md (1 hunks)
• docs/admin/clustering/index.md (0 hunks)
• docs/admin/create-user.md (1 hunks)
• docs/admin/index.md (1 hunks)
• docs/admin/memory.md (1 hunks)

💤 Files with no reviewable changes (1)

• docs/admin/clustering/index.md

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: bmunkholm
Repo: crate/cratedb-guide PR: 340
File: docs/home/index.md:84-97
Timestamp: 2025-09-25T19:31:54.320Z
Learning: In the CrateDB Guide docs (MyST), the CrateDB Cloud card on the homepage should link to `getting-started` using `:link-type: ref` instead of the previous `cloud:index` intersphinx target. This change was implemented in PR #340 to direct users to the getting started section rather than directly to the Cloud documentation.

Learnt from: amotl
Repo: crate/cratedb-guide PR: 465
File: docs/admin/troubleshooting/system-tables.md:6-6
Timestamp: 2025-10-30T23:12:30.165Z
Learning: In the cratedb-guide repository, documentation headers and titles should use sentence case (e.g., "Diagnostics with system tables") rather than title case (e.g., "Diagnostics with System Tables"). This style choice enables headers to be referenced more fluently within sentences.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build docs

🔇 Additional comments (4)

docs/admin/create-user.md (1)

1-4: Heading and label changes align with documentation style.

The heading change from "Create User" to "User management" uses sentence case, consistent with the guidance in the learnings. Retaining the original (create-user)= label alongside the new (user-management)= label ensures backward compatibility with any existing cross-references.

docs/admin/circuit-breaker.md (1)

3-3: Heading capitalization standardized to sentence case.

The change from "Circuit Breaker" to "Circuit breaker" aligns with the documentation style guidance.

docs/admin/memory.md (1)

3-3: Heading capitalization standardized to sentence case.

The change from "Memory Configuration" to "Memory configuration" aligns with the documentation style guidance.

docs/admin/index.md (1)

34-34: Navigation reorganization is complete and correct.

The verification confirms:

• ✓ docs/admin/scale/index.md exists
• ✓ docs/admin/index.md contains the new "Scaling <scale/index>" toctree entry
• ✓ docs/admin/clustering/index.md no longer contains a scale-related toctree entry (only Multi-Node Setup and Multi-Zone Setup remain)

The migration of the scale-clusters documentation to the admin parent folder has been successfully completed without broken references.

---

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