docs: improve versioned Helm chart installation #215
Conversation
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @Eeshu-Yadav, 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 enhancing the documentation for installing Kmesh Helm charts in the quick-start.md guide. The primary goal is to clarify versioning practices for OCI-based installations and to introduce a new, explicit method for installing directly from a Helm chart archive, thereby improving user experience and consistency across installation instructions.
Highlights
- Documentation Improvement: Expanded the guidance for OCI Helm chart installation, providing clear examples for specifying stable, pre-release, and omitting the version for the latest release.
- New Installation Method: Introduced a new installation option for Helm charts via a
.tgzarchive, including the command syntax and a placeholder for the version, linking to GitHub Releases. - Content Reorganization: Updated and renumbered the installation options in the
quick-start.mddocument to accommodate the new Helm Chart Archive method, shifting 'Install from Yaml' to Option 4.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request improves the installation documentation by adding instructions for installing from a Helm chart archive and clarifying version selection. The changes are a good addition. I've added a couple of suggestions to further enhance the clarity of the instructions and ensure consistency, which should help prevent potential user confusion.
docs/setup/quick-start.md
Outdated
| - Use --version v1.1.0-alpha for pre-releases | ||
| - Omit --version to install the latest version (not recommended for production) |
There was a problem hiding this comment.
To improve clarity, I suggest rephrasing these lines. The repetition of --version is a bit redundant since the command is already shown above. Focusing on the version format itself makes the examples more direct and easier to understand.
| - Use --version v1.1.0 for stable releases | |
| - Use --version v1.1.0-alpha for pre-releases | |
| - For stable releases, use a version like `v1.1.0`. | |
| - For pre-releases, use a version like `v1.1.0-alpha`. |
| helm install kmesh ./kmesh-helm-<version>.tgz -n kmesh-system --create-namespace | ||
| ``` | ||
| - Replace `<version>` with your desired version from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases): | ||
|
|
There was a problem hiding this comment.
This instruction could be clearer to prevent user error. I recommend the following changes:
- Add an example version (e.g.,
v1.1.0) to clarify that thevprefix is needed. - Enclose the
<version>placeholder in backticks for consistency with other placeholders in the document. - Remove the extra space before the link for correct markdown formatting.
- Replace the trailing colon with a period, as this is a complete sentence.
| - Replace `<version>` with your desired version from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases): | |
| - Replace `<version>` with your desired version from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases) (e.g., `v1.1.0`). |
Eeshu-Yadav
force-pushed
the
issue-181/version-specific-install
branch
3 times, most recently
from
f9d7aa1 to
94ea22e
Compare
Signed-off-by: Eeshu-Yadav <eeshuyadav123@gmail.com>
Eeshu-Yadav
force-pushed
the
issue-181/version-specific-install
branch
from
94ea22e to
6d37278
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hzxuzhonghu The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
3 participants
Resolves #181