docs: standardize and improve getting started guide#309
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 |
![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 refactors the Kmesh Quick Start guide by introducing Docusaurus tabs to organize cluster preparation, Istio installation, and Kmesh deployment methods. While the structural changes improve readability, the review identifies several critical issues in the documentation logic and command portability. Specifically, the 'Service Connectivity' verification step is logically misplaced as it occurs before the sample applications are deployed. Furthermore, multiple commands rely on hardcoded pod names or JSONPath expressions that would fail in multi-node clusters; these should be updated to use label selectors to ensure the guide is functional for all users.
- Restructure quick-start guide using Docusaurus Tabs for cluster preparation, Istio installation, Kmesh installation, verification, and uninstallation sections - Use label selectors instead of hardcoded pod names for portability - Fix kubectl logs JSONPath to target first pod in multi-node clusters - Remove premature connectivity test from verification section - Separate commands from output into distinct code blocks - Synchronize install/uninstall tabs via shared groupId Signed-off-by: vanshika2720 <pahalvanshikaa@gmail.com>
vanshika2720
force-pushed
the
docs/improve-getting-started
branch
from
9581023 to
942c10e
Compare
Signed-off-by: vanshika2720 <pahalvanshikaa@gmail.com>
vanshika2720
force-pushed
the
docs/improve-getting-started
branch
from
94aae0d to
5fe28de
Compare
[Docs] Standardize and Improve the "Getting Started" Guide
Description
This pull request standardizes and improves the formatting and readability of the Kmesh Quick Start guide (
docs/setup/quick-start.md). Previously, the guide presented multiple environment preparation, installation, verification, and uninstallation paths sequentially, which resulted in a lengthy document with repetitive sections.To improve the developer onboarding experience, this PR introduces Docusaurus
<Tabs>to clearly separate instructions based on the user's specific environment and chosen installation method.Key Changes
kind (Recommended),minikube, andExisting Clustertabs.Istio Ambient Mode (Recommended)andIstiod Only (Minimal)tabs.OCI Registry,Local Helm Chart,Helm Archive,YAML Manifests) into tabs. Linked the uninstallation tabs to the samegroupId(install-method) so Docusaurus automatically synchronizes the clean-up instructions with the user's selected installation preference.Checklist
<Tabs>syntax andgroupIdsynchronization.Signed-off-by) to all commits.