Skip to content

Commit bd06ec8

Browse files
committed
fix: markdown lint
Signed-off-by: Wen Zhou <wenzhou@redhat.com>
1 parent 2b6d4fd commit bd06ec8

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ We welcome contributions to the llm-d-modelservice chart! If you have a bug fix,
2323

2424
Before submitting a pull request, please make sure you have the following tools installed:
2525

26-
- [Helm](http://helm.sh/)
26+
- [Helm](https://helm.sh/)
2727
- [Chart Testing](https://github.com/helm/chart-testing)
2828
- [pre-commit](https://pre-commit.com/)
2929
<!-- TODO: Once supported, also install:
@@ -80,7 +80,7 @@ make pre-commit-run
8080
For every Pull Request submitted, ensure the following steps have been done:
8181

8282
1. [Sign your commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
83-
2. [Sign-off your commits](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt-code--signoffcode)
83+
2. [Sign-off your commits](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff)
8484
3. Ensure that the `make lint`, `make verify` command runs successfully to validate your changes
8585
4. Update the version number in the [`charts/llm-d-modelservice/Chart.yaml`](charts/llm-d-modelservice/Chart.yaml) file using
8686
[semantic versioning](https://semver.org/). Follow the `X.Y.Z` format so the nature of the changes is reflected in the

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Note that the field `llm-d.ai/role` will be addition in addition to the labels s
4444

4545
### HTTPRoute
4646

47-
In addition to deploying the GAIE chart, an `HTTPRoute` is typically required to connect the `Gateway` to the `InferencePool`. Creating an HTTPRoute is not part of either chart. Some examples are provided [here](https://github.com/llm-d-incubation/llm-d-modelservice/blob/main/examples/README.md#httproute).
47+
In addition to deploying the GAIE chart, an `HTTPRoute` is typically required to connect the `Gateway` to the `InferencePool`. Creating an HTTPRoute is not part of either chart. Some examples are provided [here](examples/README.md#httproute-examples).
4848

4949
## Examples
5050

examples/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ helm repo update
1414
|---------|-------------|----------------------|
1515
| [`values-cpu.yaml`](#1-cpu-only) | CPU-only inference example | Single node, no GPU required |
1616
| [`values-pd.yaml`](#2-pd-disaggregation) | Prefill/decode disaggregation example | Multi-GPU, demonstrates P/D splitting |
17-
| [`values-xpu.yaml`](#5-intel-xpu-examples) | Intel XPU single-node example | Intel Data Center GPU Max |
18-
| [`pvc/`](#4-loading-a-model-from-a-pvc) | Persistent volume examples | Shows different storage options |
17+
| [`values-xpu.yaml`](#4-intel-xpu-examples) | Intel XPU single-node example | Intel Data Center GPU Max |
18+
| [`pvc/`](#3-loading-a-model-from-a-pvc) | Persistent volume examples | Shows different storage options |
1919
| [`dra/`](#6-dynamic-resource-allocation) | Dynamic Resource Allocation (DRA) examples | Shows different DRA use cases |
2020

21-
All the examples assume a `Gateway` and GAIE configuration have been deployed. See the [llm-d guides](https://github.com/llm-d/llm-d/tree/main/guides) for examples. Further, an `HTTPRoute` must be deployed. Some examples of `HTTPRoute` is provided [below](https://github.com/llm-d-incubation/llm-d-modelservice/blob/main/examples/README.md#httproute).
21+
All the examples assume a `Gateway` and GAIE configuration have been deployed. See the [llm-d guides](https://github.com/llm-d/llm-d/tree/main/guides) for examples. Further, an `HTTPRoute` must be deployed. Some examples of `HTTPRoute` is provided [below](#httproute-examples).
2222

2323
## Usage Examples
2424

0 commit comments

Comments
 (0)