-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update 7.0.0 Release Notes for -rc.2 #222
Conversation
WalkthroughThis pull request encompasses updates to two significant documentation files for Unraid OS. The first document, Changes
Sequence DiagramsequenceDiagram
participant User
participant Tailscale
participant Unraid
participant Docker
User->>Tailscale: Sign up and configure
Tailscale-->>User: Provide authentication
User->>Unraid: Install Tailscale plugin
Unraid->>Tailscale: Authenticate and connect
User->>Docker: Configure Tailscale in containers
Docker->>Tailscale: Establish VPN connection
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/unraid-os/manual/security/tailscale.md (2)
103-118
: Consider adding a note about path permissionsThe instructions for configuring the Tailscale state directory are clear, but it would be helpful to mention that the chosen directory should have appropriate permissions for the container to read/write state files.
🧰 Tools
🪛 LanguageTool
[typographical] ~105-~105: Use a comma after an introductory phrase.
Context: ...he Container Path for that mapping. For this example we will assume it is/container-path/
...(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~112-~112: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...tate ``` 3. Start the container and it will use your specified directory to...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~113-~113: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...his variable to the container’s XML file so your users don’t have to do this: ...(COMMA_COMPOUND_SENTENCE_2)
Line range hint
338-341
: Improve grammar and clarity in Tailscale updatesThe bullet points would benefit from more descriptive text and proper grammar:
-* Warn if cannot find persistent storage for Tailscale state [-rc.2] +* Added warning when persistent storage for Tailscale state cannot be found [-rc.2]🧰 Tools
🪛 LanguageTool
[uncategorized] ~100-~100: Consider adding a hyphen.
Context: ...asic View** to Advanced View in the upper right corner of the Edit Docker page. To over...(TOP_LEFT_CORNER)
[typographical] ~105-~105: Use a comma after an introductory phrase.
Context: ...he Container Path for that mapping. For this example we will assume it is/container-path/
...(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~112-~112: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...tate ``` 3. Start the container and it will use your specified directory to...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~113-~113: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...his variable to the container’s XML file so your users don’t have to do this: ...(COMMA_COMPOUND_SENTENCE_2)
docs/unraid-os/release-notes/7.0.0.md (2)
491-493
: Maintain consistent version number formattingFor better readability and consistency, consider using the same format for version numbers throughout the document. For example:
- Some versions use dots (6.6.66)
- Others use underscores (2.2.7_6.6.66_Unraid)
567-567
: Consider highlighting security-related package updatesFor security-sensitive packages like
ca-certificates
,curl
, andsudo
, consider adding brief notes about security fixes or important changes included in the updates.Also applies to: 576-576, 820-820
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/unraid-os/manual/security/tailscale.md
(1 hunks)docs/unraid-os/release-notes/7.0.0.md
(29 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/unraid-os/release-notes/7.0.0.md
[grammar] ~338-~338: It seems that a pronoun is missing.
Context: ...s/manual/security/tailscale.md) * Warn if cannot find persistent storage for Tail...
(IF_VB)
[grammar] ~560-~560: Make sure that the singular noun after the number ‘1.3’ is correct.
Context: ...n: version 2.15.0 * beep: version 1.3 * bin: version 11.1 * bind: version 9.20.4 * ...
(CD_POINT_CD_NN)
[grammar] ~561-~561: Make sure that the singular noun after the number ‘11.1’ is correct.
Context: ...beep: version 1.3 * bin: version 11.1 * bind: version 9.20.4 * bluez-firmware: versi...
(CD_POINT_CD_NN)
[grammar] ~759-~759: Possible agreement error. The noun ‘mesa’ seems to be countable.
Context: ... version 4.8.31 * mcelog: version 202 * mesa: version 24.3.1 * miniupnpc: version 2....
(CD_NN)
docs/unraid-os/manual/security/tailscale.md
[typographical] ~105-~105: Use a comma after an introductory phrase.
Context: ...he Container Path for that mapping. For this example we will assume it is /container-path/
...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~112-~112: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...tate ``` 3. Start the container and it will use your specified directory to...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~113-~113: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...his variable to the container’s XML file so your users don’t have to do this: ...
(COMMA_COMPOUND_SENTENCE_2)
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
Documentation
New Features
Bug Fixes