docs: Update install docs to use Helm OCI registry#277
docs: Update install docs to use Helm OCI registry#277imshubham22apr-gif wants to merge 1 commit intokmesh-net:mainfrom
Conversation
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @imshubham22apr-gif! It looks like this is your first PR to kmesh-net/website 🎉 |
Summary of ChangesHello, 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 refines the Kmesh installation documentation to streamline the user experience. It re-prioritizes the Helm OCI registry method as the recommended approach for its simplicity, while clearly organizing and labeling alternative installation paths for developers who need to install from source or require more specific configurations. 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. Footnotes
|
Signed-off-by: imshubham22apr-gif <imshubham.22apr@gmail.com>
imshubham22apr-gif
force-pushed
the
fix/helm-oci-install-docs
branch
from
ee872ac to
feb205b
Compare
There was a problem hiding this comment.
Pull request overview
Updates the quickstart installation guide to recommend installing Kmesh via Helm from the GitHub Container Registry (OCI) as the primary path, while keeping source-based alternatives available for developers.
Changes:
- Makes Helm OCI (GHCR) the recommended/default install method and updates the example command.
- Reorganizes non-OCI install paths under a developer-focused “Alternative” section with multiple methods.
- Updates surrounding explanatory text and links for version selection and release artifacts.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| We offer several ways to install Kmesh: | ||
| The recommended way to install Kmesh is via Helm from the OCI registry. This method is the simplest and doesn't require cloning the repository. | ||
|
|
||
| ### Option 1: Install from OCI Registry (Recommended) |
| > **Note**: These methods require you to clone the [Kmesh repository](https://github.com/kmesh-net/kmesh) first: | ||
| > ```shell | ||
| > git clone https://github.com/kmesh-net/kmesh.git | ||
| > cd kmesh | ||
| > ``` |
| ### Option 3: Install from Helm Chart Archive | ||
| #### Method 2: Install from Helm Chart Archive | ||
|
|
||
| Download the `kmesh-helm-<version>.tgz` archive from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases). Replace `<version>` in the command above with the version you downloaded (e.g., `v1.2.0`). |
|
|
||
| ### Alternative: Install from Source (For Developers) | ||
|
|
||
| If you're a developer and need to install from a local source code directory or require more customization, use one of the following methods. |
![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 significantly improves the installation documentation by restructuring the quick start guide. Highlighting the Helm OCI registry as the recommended method and separating developer-focused source installations makes the guide much clearer for new users. The changes are well-organized and align with the goal of providing a smoother onboarding experience. I've included a couple of minor suggestions to further enhance clarity and consistency.
| - For stable releases, use a version like `v1.1.0`. | ||
| - For pre-releases, use a version like `v1.1.0-alpha`. |
There was a problem hiding this comment.
The main command on line 93 uses version v1.2.0, but the examples for stable and pre-releases here refer to v1.1.0 and v1.1.0-alpha. To improve consistency and avoid potential confusion for users, it would be better to update these examples to align with the version used in the main command.
| - For stable releases, use a version like `v1.1.0`. | |
| - For pre-releases, use a version like `v1.1.0-alpha`. | |
| - For stable releases, use a version like `v1.2.0`. | |
| - For pre-releases, use a version like `v1.2.0-alpha`. |
| ### Option 3: Install from Helm Chart Archive | ||
| #### Method 2: Install from Helm Chart Archive | ||
|
|
||
| Download the `kmesh-helm-<version>.tgz` archive from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases). Replace `<version>` in the command above with the version you downloaded (e.g., `v1.2.0`). |
There was a problem hiding this comment.
This instruction refers to "the command above", but the relevant command block is actually located below this line. To prevent confusion, please change "above" to "below".
| Download the `kmesh-helm-<version>.tgz` archive from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases). Replace `<version>` in the command above with the version you downloaded (e.g., `v1.2.0`). | |
| Download the `kmesh-helm-<version>.tgz` archive from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases). Replace `<version>` in the command below with the version you downloaded (e.g., `v1.2.0`). |
Fixes kmesh-net/kmesh#575
Hey everyone! As discussed in the issue thread, this updates the quickstart guide to highlight the Helm OCI registry installation as the primary method, which should be much smoother for standard users.
I've kept the original source installation method available as an alternative for developers who still need it.
Let me know if you'd like any formatting tweaks!