Fix paths to files when resetting root password #221
Conversation
WalkthroughThe pull request involves updating the Unraid OS manual documentation for password reset procedures. The changes focus on correcting file paths related to password storage and improving formatting in the user instructions. The modifications ensure more accurate guidance for users seeking to reset their root password, with specific attention to the precise locations of shadow and SMB password files. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/unraid-os/manual/users/reset-password.md (1)
Line range hint
24-41: Consider using variables for system pathsTo make future path updates easier and ensure consistency, consider introducing documentation variables or constants for commonly referenced system paths. This could be implemented using your documentation framework's features.
Example approach:
Define at the top of the documentation: {%set CONFIG_DIR = "/config" %} Then use throughout: {{CONFIG_DIR}}/shadow
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/unraid-os/manual/users/reset-password.md(2 hunks)
🔇 Additional comments (2)
docs/unraid-os/manual/users/reset-password.md (2)
41-41: LGTM! Path is now consistent
The updated path in the Advanced method matches the Basic method, maintaining consistency throughout the document.
24-25: Verify path consistency across documentation
The updated paths look correct, but let's ensure they are consistent with other documentation references.
| <li> | ||
| <i>(Optional)</i> If you have any user accounts configured in <b><i>Users → Shares Access</i></b> (or <b><i>Settings → Users → Shares Access</i></b>), select each user and enter a new password. Be sure to select <b>Change</b> and not <b>Done</b> after this. |
There was a problem hiding this comment.
💡 Codebase verification
Inconsistent arrow symbols need standardization
The documentation currently uses mixed arrow styles:
- "→" (Unicode arrow) in reset-password.md
- ">" (greater than) in manage-user.md and create-user.md
- "->" (hyphen + greater than) in release-notes/6.9.0.md
This inconsistency should be addressed by standardizing on one style across all documentation.
🔗 Analysis chain
Verify arrow symbol consistency
The change from ">" to "→" improves readability. Let's verify this matches the style used in other documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for different arrow styles in navigation paths
# to ensure consistency across documentation
echo "Checking for arrow symbols in navigation paths:"
rg -i "users.*>.*shares|settings.*>.*users" --type md
Length of output: 925
There was a problem hiding this comment.
This rg command looks incredibly powerful, would be a good way to find these types of consistency issues across the docs site
There was a problem hiding this comment.
@ljm42, I'm glad you find the rg command useful! It's indeed a powerful way to uncover consistency issues across the documentation.
(^・ω・^ )
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
Before Submitting This PR, Please Ensure You Have Completed The Following:
Summary by CodeRabbit