Revise smb docs - #56
Conversation
Summary of ChangesHello @tsaishawn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the clarity and accuracy of the SMB documentation. It refines descriptions for key configuration fields during SMB share creation and updates the procedural steps for modifying existing shares, ensuring users receive more precise instructions and have appropriate expectations regarding the application of changes. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request revises the SMB documentation. While the changes aim to clarify some steps, they also remove helpful examples and introduce a minor inconsistency. My review includes suggestions to restore the examples for better user guidance and points out an inconsistency between a section header and its content to improve clarity.
| 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). |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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`).
|
|
||
| 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). |
There was a problem hiding this comment.
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.
| 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). | ||
| 2. Update the desired settings. |
There was a problem hiding this comment.
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**).
1 participant
No description provided.