Skip to content

fix: improve documentation links and consistency in Quick Start guide #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shubhtrek wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: improve documentation links and consistency in Quick Start guide #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26f2db0
docs: fix typo in community meeting frequency
shubhtrek May 2, 2026
37ebe6e
fix: improve documentation links and consistency in quick start guide
shubhtrek May 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/community/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The community's goal is to build a high-performance service governance framework

We host regular community meetings where contributors, maintainers, and users can share updates, discuss ideas, and collaborate on ongoing work.

- **Frequency:** Every 2 weeks on **Thursday**
- **Frequency:** Every week on **Thursday**
- **Time:** 16:00 China / 08:00 UTC / 13:30 India Standard Time [Convert to your timezone](https://dateful.com/time-zone-converter?t=14%3A30&tz=GMT%2B8&)
- **Meeting Link:** [Joining Link](https://zoom-lfx.platform.linuxfoundation.org/meeting/99299011908?password=f4c31ddd-11ed-42ae-a617-3e0842c39c58)
- **Meeting Notes & Agenda:** [Google Docs](https://docs.google.com/document/d/1fFqolwWMVMk92yXPHvWGrMgsrb8Xru_v4Cve5ummjbk/edit?tab=t.0#heading=h.o8pz6aqnzzgk)
Expand Down
12 changes: 6 additions & 6 deletions docs/setup/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Before installing Kmesh, ensure your environment meets the following requirement

## Preparation

Kmesh needs to run on a Kubernetes cluster. Kubernetes 1.26+ are currently supported. We recommend using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) to quickly provide a Kubernetes cluster (We provide a [document](develop-with-kind/) for developing and deploying Kmesh using kind). Of course, you can also use [minikube](https://minikube.sigs.k8s.io/docs/) and other ways to create Kubernetes clusters.
Kmesh needs to run on a Kubernetes cluster. Kubernetes 1.26+ are currently supported. We recommend using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) to quickly provide a Kubernetes cluster (We provide a [document](/docs/setup/develop-with-kind/) for developing and deploying Kmesh using kind). Of course, you can also use [minikube](https://minikube.sigs.k8s.io/docs/) and other ways to create Kubernetes clusters.

@gemini-code-assist gemini-code-assist Bot May 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In Docusaurus, it is recommended to use relative paths to .md files for internal links (e.g., [document](./develop-with-kind.md)). This ensures that links are validated at build time and remain portable if the documentation structure changes or if the site is hosted at a subpath.

Suggested change
Kmesh needs to run on a Kubernetes cluster. Kubernetes 1.26+ are currently supported. We recommend using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) to quickly provide a Kubernetes cluster (We provide a [document](/docs/setup/develop-with-kind/) for developing and deploying Kmesh using kind). Of course, you can also use [minikube](https://minikube.sigs.k8s.io/docs/) and other ways to create Kubernetes clusters.
Kmesh needs to run on a Kubernetes cluster. Kubernetes 1.26+ are currently supported. We recommend using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) to quickly provide a Kubernetes cluster (We provide a [document](./develop-with-kind.md) for developing and deploying Kmesh using kind). Of course, you can also use [minikube](https://minikube.sigs.k8s.io/docs/) and other ways to create Kubernetes clusters.
References
  1. Use relative file paths for internal documentation links to ensure build-time validation and portability.


Currently, Kmesh makes use of [istio](https://istio.io/) as its control plane. Before installing Kmesh, please install the Istio control plane. We recommend installing istio ambient mode because Kmesh `dual-engine` mode need it. For details, see [ambient mode istio](https://istio.io/latest/docs/ops/ambient/getting-started/).
Currently, Kmesh makes use of [istio](https://istio.io/) as its control plane. Before installing Kmesh, please install the Istio control plane. We recommend installing Istio ambient mode because Kmesh `dual-engine` mode needs it. For details, see [ambient mode Istio](https://istio.io/latest/docs/ops/ambient/getting-started/).

@gemini-code-assist gemini-code-assist Bot May 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The first occurrence of 'istio' in this line should be capitalized as 'Istio' for consistency with the rest of the sentence and the PR's stated goal of fixing naming consistency.

Suggested change
Currently, Kmesh makes use of [istio](https://istio.io/) as its control plane. Before installing Kmesh, please install the Istio control plane. We recommend installing Istio ambient mode because Kmesh `dual-engine` mode needs it. For details, see [ambient mode Istio](https://istio.io/latest/docs/ops/ambient/getting-started/).
Currently, Kmesh makes use of [Istio](https://istio.io/) as its control plane. Before installing Kmesh, please install the Istio control plane. We recommend installing Istio ambient mode because Kmesh `dual-engine` mode needs it. For details, see [ambient mode Istio](https://istio.io/latest/docs/ops/ambient/getting-started/).
References
  1. Maintain consistent capitalization for product names like Istio throughout the documentation.


You can view the results of istio installation using the following command:

Expand All @@ -41,12 +41,12 @@ ztunnel-4jlvv 1/1 Running 0 18h

```shell
kubectl get crd gateways.gateway.networking.k8s.io &> /dev/null || \
{ kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=444631bfe06f3bcca5d0eadf1857eac1d369421d" | kubectl apply -f -; }
{ kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental" | kubectl apply -f -; }
```

### Only install Istiod

Installing ambient mode istio by above steps will install additional istio components.
Installing ambient mode istio by above steps will install additional Istio components.

@gemini-code-assist gemini-code-assist Bot May 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The word 'istio' should be capitalized as 'Istio' here to maintain consistency throughout the document.

Suggested change
Installing ambient mode istio by above steps will install additional Istio components.
Installing ambient mode Istio by above steps will install additional Istio components.
References
  1. Maintain consistent capitalization for product names like Istio throughout the documentation.


The process of installing only `istiod` as the control plane for Kmesh is provided next.

Expand Down Expand Up @@ -78,7 +78,7 @@ After installing istiod, it's time to install Kubernetes Gateway API CRDs.

```shell
kubectl get crd gateways.gateway.networking.k8s.io &> /dev/null || \
{ kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=444631bfe06f3bcca5d0eadf1857eac1d369421d" | kubectl apply -f -; }
{ kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental" | kubectl apply -f -; }
```

## Install Kmesh
Expand Down Expand Up @@ -321,5 +321,5 @@ kubectl delete -f samples/sleep/sleep.yaml
If you installed the Gateway API CRDs, remove them:

```shell
kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=444631bfe06f3bcca5d0eadf1857eac1d369421d" | kubectl delete -f -
kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental" | kubectl delete -f -
```
12 changes: 6 additions & 6 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2276,10 +2276,10 @@
dependencies:
"@types/mdx" "^2.0.0"

"@node-rs/jieba-darwin-arm64@2.0.1":
"@node-rs/jieba-win32-x64-msvc@2.0.1":
version "2.0.1"
resolved "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-2.0.1.tgz"
integrity sha512-10+nwGQ6KzXXJlIL/sELA6Fi6m7eJ7xJksBiKuw1kxKUgaJwtVfAG0iqRF+NRQv0Sdq7r3k5ew9K9y0+IYaEcA==
resolved "https://registry.npmjs.org/@node-rs/jieba-win32-x64-msvc/-/jieba-win32-x64-msvc-2.0.1.tgz"
integrity sha512-LDOyo2/2CO8UnpSGLJdgqtH8mOnsABPhNxkfIky7UT9cyLEzOaU44nbA5YzPGpBI3qzMbWcwJYQsjBcgK2VqAg==
Comment on lines +2279 to +2282

@gemini-code-assist gemini-code-assist Bot May 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The yarn.lock file has been modified to replace Darwin (macOS) dependencies with Windows-specific ones. This typically occurs when the lockfile is updated on a Windows machine without cross-platform support configured. This change will break the build for macOS users and should be reverted. Unrelated lockfile changes should generally be avoided in documentation PRs.

References
  1. Avoid committing platform-specific lockfile changes that prune dependencies for other supported operating systems.


"@node-rs/jieba@^2.0.1":
version "2.0.1"
Expand Down Expand Up @@ -2322,10 +2322,10 @@
"@nodelib/fs.scandir" "2.1.5"
fastq "^1.6.0"

"@parcel/watcher-darwin-arm64@2.5.1":
"@parcel/watcher-win32-x64@2.5.1":
version "2.5.1"
resolved "https://registry.npmjs.org/@parcel/watcher-darwin-arm64/-/watcher-darwin-arm64-2.5.1.tgz"
integrity sha512-eAzPv5osDmZyBhou8PoF4i6RQXAfeKL9tjb3QzYuccXFMQU0ruIc/POh30ePnaOyD1UXdlKguHBmsTs53tVoPw==
resolved "https://registry.npmjs.org/@parcel/watcher-win32-x64/-/watcher-win32-x64-2.5.1.tgz"
integrity sha512-9lHBdJITeNR++EvSQVUcaZoWupyHfXe1jZvGZ06O/5MflPcuPLtEphScIBL+AiCWBO46tDSHzWyD0uDmmZqsgA==

"@parcel/watcher@^2.4.1":
version "2.5.1"
Expand Down