Fix/add object detail - #57
Conversation
Summary of ChangesHello @george-wu20250203, 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 focuses on improving the clarity and completeness of the documentation related to storage pool management and object storage (S3). It refines existing instructions for creating and modifying storage pools, enhances the object storage dashboard's descriptive content, and introduces a new guide for accessing S3 buckets via S3 Browser. These changes aim to provide users with more precise and helpful information for managing their storage resources. 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 updates the documentation for storage pools and object storage. The changes include reorganizing the pool creation steps, adding details to the object storage overview, and providing a new guide for accessing buckets with an S3 browser. My review focuses on improving the clarity, consistency, and structure of the documentation. I've pointed out a potential inconsistency in the pool creation steps and suggested improvements to the new S3 browser guide to make it more user-friendly.
| 4. **Quota**: Optionally set limits on the pool's usage: | ||
| - **Max Bytes**: The maximum amount of data (in GB or TB) the pool can store. | ||
| 5. **Advanced Settings (Optional)**: | ||
| - **Max Objects**: The maximum number of objects the pool can store. |
There was a problem hiding this comment.
The "Applications" step has been removed from the pool creation process in the documentation. However, the "Applications" column is still listed in the pool overview table (line 28), suggesting it's an important property. Was this removal intentional? If users can no longer set applications during creation, it would be helpful to document how this property is assigned. If it was an accidental removal, please consider adding it back.
| <Card title="Bucket" icon="tabler:bucket"> | ||
| The total number of S3 buckets currently defined in the system. | ||
| The total number of S3 buckets currently defined in the system. | ||
|
|
||
| The RGW endpoint IP that clients use to access the bucket via S3-compatible APIs. | ||
| </Card> |
There was a problem hiding this comment.
The information about the RGW endpoint seems misplaced within the "Bucket" card, which primarily describes the total count of buckets. The RGW endpoint is a service-level detail that applies to all buckets. Consider moving this information to a more general location, such as the introductory paragraph of the "Bucket" section (around line 14) or the main "Object" page introduction (around line 8), for better logical organization.
| 1. Create a user in User section. | ||
| 2. Create an access key for the user and copy the secret key. | ||
| 3. Create a bucket and assign the user as the owner. The bucket owner always has full control of the bucket regardless of the selected ACL. | ||
| 4. Open S3 Browser. | ||
| 5. Fill in the account settings: | ||
| - Account type: S3 compatible storage | ||
| - API endpoint: RGW endpoint | ||
| - Access Key ID: User’s access key. | ||
| - Secret Access Key: The copied secret key. | ||
| - Use secure transfer: Disable SSL | ||
| 6. Add new account | ||
|
|
||
| </Steps> | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
This new section is a great addition! To make it even clearer for users, I've suggested a few improvements:
- Made "User section" a markdown link for easier navigation.
- Made the instructions for
Access Key IDandSecret Access Keymore specific by referring back to the step where they were created. - Removed several extra blank lines for cleaner formatting.
Additionally, in step 5, could you clarify where the user can find the RGW endpoint value? It would be helpful to mention if it's displayed somewhere in the UI.
1. Create a user in the [User section](#user).
2. Create an access key for the user and copy the secret key.
3. Create a bucket and assign the user as the owner. The bucket owner always has full control of the bucket regardless of the selected ACL.
4. Open S3 Browser.
5. Fill in the account settings:
- Account type: S3 compatible storage
- API endpoint: RGW endpoint
- Access Key ID: The access key generated in step 2.
- Secret Access Key: The secret key copied in step 2.
- Use secure transfer: Disable SSL
6. Add new account
</Steps>
3 participants
No description provided.