Skip to content

Revise smb docs #56

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.

Sign up for GitHub

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

Merged
tsaishawn merged 1 commit into from
Jan 2, 2026
Merged

Revise smb docs #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/content/docs/service/storage/05-smb.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ You can create new SMB shares to expose storage to your network.

1. Click the **Create** button.
2. **Name**: Enter a unique name for the share.
3. **Port**: Optionally specify a custom port (default is 445).
3. **Port**: Optionally specify a custom port (use 445 port for Windows client).

@gemini-code-assist gemini-code-assist Bot Jan 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The updated description for the port removes the information that 445 is the default. While mentioning it's used for Windows clients is helpful, knowing the default value is also important for users. Please consider combining both pieces of information for better clarity.

3.  **Port**: Optionally specify a custom port. The default is 445, which is standard for Windows clients.

4. **Size**: Specify the storage size for the share (e.g., 100 GB).
5. **Common Configuration**:
- **Map To Guest**: Configure how to handle guest access (e.g., `Never`, `Bad User`).
- **Map To Guest**: Configure how to handle guest access.

@gemini-code-assist gemini-code-assist Bot Jan 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Removing the examples for Map To Guest makes the documentation less helpful, as they provide valuable context on expected values. It would be beneficial to restore them. For consistency with the table description on line 32, you could also include Bad Password as an example.

    - **Map To Guest**: Configure how to handle guest access (e.g., `Never`, `Bad User`, `Bad Password`).

6. **Security Configuration**:
- **Mode**: Select **User** (local users) or **Active Directory**.
- **Local Users** (User Mode): Manage local username and password credentials.
Expand All @@ -69,8 +69,9 @@ Allows you to update the share's configuration, including size, security setting

<Steps>

1. Select **Edit** from the actions menu (pencil icon).
2. Update the desired settings (e.g., **Size**, **Valid Users**, **Browsable**).
1. Select **Update** from the actions menu (pencil icon).

@gemini-code-assist gemini-code-assist Bot Jan 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Changing 'Edit' to 'Update' in this step creates an inconsistency with the section header '### Edit SMB Share' on line 66. To avoid user confusion, consider aligning the terminology. If 'Update' is correct, the section header should probably be changed as well in a separate PR.

2. Update the desired settings.

@gemini-code-assist gemini-code-assist Bot Jan 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Removing the examples of settings that can be updated (e.g., Size, Valid Users, Browsable) makes this instruction more vague. Restoring these examples would provide clearer guidance to the user on what they can modify.

2.  Update the desired settings (e.g., **Size**, **Valid Users**, **Browsable**).

3. Click **Confirm** to save changes.
4. Wait a few minutes for the settings to take effect.

</Steps>
Loading