Skip to content

Update Parity Swap process description (to clarify disk replacement order)#495

Open
DigicoolThings wants to merge 1 commit into
unraid:mainfrom
DigicoolThings:patch-1
Open

Update Parity Swap process description (to clarify disk replacement order)#495
DigicoolThings wants to merge 1 commit into
unraid:mainfrom
DigicoolThings:patch-1

Conversation

@DigicoolThings
Copy link
Copy Markdown

@DigicoolThings DigicoolThings commented May 28, 2026

Clarify the Parity Swap process description to correctly state that the new parity disk is installed first (previous wording indicated the new parity was installed as the second step).

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • Documentation
    • Updated the Parity swap procedure documentation to clarify the correct sequence of operations when replacing disks in the array.

Review Change Stack

Clarify the Parity Swap process description to correctly state that the new parity disk is installed first (previous wording indicated the new parity was installed as the second step).
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

📝 Walkthrough

Walkthrough

A single-line documentation update clarifies the sequence of operations in the parity swap procedure: the new larger disk is installed as parity first, then the previous parity disk is moved to a data slot.

Changes

Parity Swap Procedure Clarification

Layer / File(s) Summary
Parity swap procedure overview
docs/unraid-os/using-unraid-to/manage-storage/array/replacing-disks-in-array.mdx
The introductory description of the parity swap section is reworded to invert the stated sequence: install the new larger disk as parity first, then move the previous parity disk to the data slot.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A swap, a line, a clearer way,
To tell which disk goes first to play,
The parity dance, now crystal clear,
No confusion left to fear!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change—updating the Parity Swap process description to clarify disk replacement order.
Description check ✅ Passed The description provides a clear explanation of the change and includes all items from the repository's required checklist template.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

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
`@docs/unraid-os/using-unraid-to/manage-storage/array/replacing-disks-in-array.mdx`:
- Line 208: The partial
docs/unraid-os/using-unraid-to/manage-storage/partials/parity-swap-what.mdx
still describes the old sequence for a parity swap (saying it "moves your
current parity disk to the data slot, then installs a new, larger disk as the
new parity disk"); update that sentence to match the corrected sequence used in
replacing-disks-in-array.mdx (describe that the process installs a new larger
disk as the new parity disk first, then installs the previous parity disk into a
data slot), keeping wording consistent with the phrasing in
replacing-disks-in-array.mdx around "installs a new, larger disk as the new
parity disk, then installs your previous parity disk to the data slot."
🪄 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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 0304e0ec-f1e0-440e-9be2-526e9b78792d

📥 Commits

Reviewing files that changed from the base of the PR and between eb2cf77 and 2e697f4.

📒 Files selected for processing (1)
  • docs/unraid-os/using-unraid-to/manage-storage/array/replacing-disks-in-array.mdx

## Parity swap

Parity swap is a special procedure used when you need to replace a data disk with a disk that is larger than your current parity disk. The process moves your current parity disk to the data slot, then installs a new, larger disk as the new parity disk. This ensures your array remains protected and allows for larger data drives in the future.
Parity swap is a special procedure used when you need to replace a data disk with a disk that is larger than your current parity disk. The process installs a new, larger disk as the new parity disk, then installs your previous parity disk to the data slot. This ensures your array remains protected and allows for larger data drives in the future.
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.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Inconsistency with shared partial needs resolution.

The updated sequence description here is correct and aligns with both the procedure steps (lines 254-256) and the example scenario (line 212). However, the shared partial at docs/unraid-os/using-unraid-to/manage-storage/partials/parity-swap-what.mdx still contains the old sequence: "moves your current parity disk to the data slot, then installs a new, larger disk as the new parity disk."

Please update the shared partial to match this corrected sequence to maintain consistency across the documentation.

🤖 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
`@docs/unraid-os/using-unraid-to/manage-storage/array/replacing-disks-in-array.mdx`
at line 208, The partial
docs/unraid-os/using-unraid-to/manage-storage/partials/parity-swap-what.mdx
still describes the old sequence for a parity swap (saying it "moves your
current parity disk to the data slot, then installs a new, larger disk as the
new parity disk"); update that sentence to match the corrected sequence used in
replacing-disks-in-array.mdx (describe that the process installs a new larger
disk as the new parity disk first, then installs the previous parity disk into a
data slot), keeping wording consistent with the phrasing in
replacing-disks-in-array.mdx around "installs a new, larger disk as the new
parity disk, then installs your previous parity disk to the data slot."

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.

1 participant