Update Get Started

[terrywu510]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @terrywu510, I'm Gemini Code Assist¹! 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 significantly enhances the 'Get Started' documentation by providing clearer, more detailed, and explicit instructions for setting up OtterScale. It refines prerequisites for both the Control Node and K8S nodes, including hardware, OS, network, and BIOS configurations. Additionally, the installation guide has been expanded with step-by-step instructions, environment configuration details, and troubleshooting advice, aiming to improve the user experience and reduce potential setup issues.

Highlights

• Prerequisites Clarity: Enhanced the clarity and detail of prerequisites for both the OtterScale Control Node and K8S nodes, covering hardware, operating system, network, and BIOS configurations.
• Network Configuration Refinement: Updated network configuration sections to explicitly state automatic installer setup while emphasizing critical prerequisites like external internet access and bridge configuration.
• K8S Node Setup Guidance: Provided more explicit instructions for K8S node setup, including detailed BIOS configuration steps and hardware requirements, clarifying their role in the Kubernetes cluster.
• Mandatory Firewall Rules: Revised firewall configuration from 'reference only' to 'mandatory' for installation, detailing required outbound access for all nodes.
• Improved Installation Guide: Expanded the installation guide with more descriptive steps, including apt update, detailed .env file configuration, service verification, and troubleshooting tips for a smoother setup experience.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the 'Get Started' documentation by adding more detail, clarifying instructions, and improving readability. The changes in 01-prerequisites.mdx and 02-installation.mdx make the setup process much clearer for new users. I've added a few suggestions to further refine the documentation, such as removing a redundant sentence and updating Docker commands to their modern syntax for better future compatibility.

[gemini-code-assist]

Similar to the previous comment, docker-compose should be updated to the modern docker compose V2 syntax for consistency and future-proofing.

    sudo docker compose ps