Skip to content

Commit abac64b

Browse files
hhk7734claudeCopilot
authored
NO-ISSUE: docs(website): fix links, YAML syntax, and add content guidelines (#63)
* NO-ISSUE: docs(website): fix links, YAML syntax, and add content guidelines - Add inference deployment content guideline to AGENTS.md - Fix broken README link (.mdx → .md) in prerequisites - Fix Kyverno policy YAML structure and template syntax in Harbor docs - Add plugin links to Heimdall API reference - Bump qs from 6.14.1 to 6.14.2 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Update website/docs/reference/heimdall/api-reference.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 341457f commit abac64b

File tree

6 files changed

+27
-21
lines changed

6 files changed

+27
-21
lines changed

‎website/AGENTS.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,7 @@ This is a warning
9292
- **Style**:
9393
- **Imperative**: Use command style for steps (e.g., "Create a file...").
9494
- **Concise**: Avoid marketing fluff. Link to prerequisites instead of repeating them.
95+
96+
## 4. Content Guidelines
97+
98+
- **Inference Deployment**: When documenting deployment of inference services (e.g., vLLM, SGLang), instructions MUST use the `InferenceService` resource with a preset.

‎website/docs/features/preset.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
sidebar_position: 1
3-
sidebar_label: Presets
42
title: Presets
3+
sidebar_label: Presets
4+
sidebar_position: 1
55
---
66

77
The MoAI Inference Framework provides a set of pre-configured `InferenceServiceTemplate`s, known as presets. These presets encapsulate standard configurations for various models and hardware setups, simplifying the deployment of inference services.

‎website/docs/getting-started/prerequisites.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ device node GUID
227227

228228
### RDMA device plugin installation
229229

230-
This section describes how to install the **rdma-shared-device-plugin**. See [k8s-rdma-shared-dev-plugin / README](https://github.com/Mellanox/k8s-rdma-shared-dev-plugin/blob/master/README.mdx) for more details.
230+
This section describes how to install the **rdma-shared-device-plugin**. See [k8s-rdma-shared-dev-plugin / README](https://github.com/Mellanox/k8s-rdma-shared-dev-plugin/blob/master/README.md) for more details.
231231

232232
First, create a `rdma-shared-device-plugin.yaml` file as follows. **You need to replace `<device>` with your RDMA NIC's network interface name**. If multiple NICs are installed on the server, you must list all interface names (e.g., `"devices": ["ib0", "ib1"]`).
233233

‎website/docs/operations/container-image-caching-with-harbor/index.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Container image caching with Harbor
3-
sidebar_position: 4
43
sidebar_label: Container image caching (Harbor)
4+
sidebar_position: 4
55
---
66

77
import Tabs from '@theme/Tabs';
@@ -354,7 +354,8 @@ spec:
354354
background: true
355355
emitWarning: false
356356
rules:
357-
- match:
357+
- name: ecr-rewrite-registry-container
358+
match:
358359
any:
359360
- resources:
360361
kinds:
@@ -365,11 +366,11 @@ spec:
365366
patchStrategicMerge:
366367
spec:
367368
containers: # set registry port as your setup (80 or 443)
368-
- image: '{{ regex_replace_all_literal("255250787067.dkr.ecr.ap-northeast-2.amazonaws.com", "{{ element.image }}, "harbor.harbor.svc.cluster.local:<yourPort>/mif") }}'
369+
- image: "{{ regex_replace_all_literal('255250787067.dkr.ecr.ap-northeast-2.amazonaws.com', '{{ element.image }}', 'harbor.harbor.svc.cluster.local:<yourPort>/mif') }}"
369370
name: '{{ element.name }}'
370-
name: ecr-rewrite-registry-container
371371
skipBackgroundRequests: true
372-
- match:
372+
- name: ecr-rewrite-registry-init-container
373+
match:
373374
any:
374375
- resources:
375376
kinds:
@@ -380,12 +381,11 @@ spec:
380381
patchStrategicMerge:
381382
spec:
382383
initContainers: # set registry port as your setup (80 or 443)
383-
- image: '{{ regex_replace_all_literal("255250787067.dkr.ecr.ap-northeast-2.amazonaws.com", "{{ element.image }}, "harbor.harbor.svc.cluster.local:<yourPort>/mif") }}'
384+
- image: "{{ regex_replace_all_literal('255250787067.dkr.ecr.ap-northeast-2.amazonaws.com', '{{ element.image }}', 'harbor.harbor.svc.cluster.local:<yourPort>/mif') }}"
384385
name: '{{ element.name }}'
385-
name: ecr-rewrite-registry-init-container
386386
preconditions:
387387
all:
388-
- key: '{{ request.object.spec.initContainers[] || `[]` | length(@) }}
388+
- key: '{{ request.object.spec.initContainers[] || `[]` | length(@) }}'
389389
operator: GreaterThanOrEquals
390390
value: 1
391391
skipBackgroundRequests: true

‎website/docs/reference/heimdall/api-reference.mdx‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,18 @@ kubectl explain --api-version inference.networking.k8s.io/v1 inferencepools.spec
7373

7474
### EndpointPickerConfig
7575

76-
| Field | Type | Description |
77-
| :------------------- | :------------------------------------------ | :-------------------------------------------------------------------------------------- |
78-
| `data` | [`DataLayerConfig`](#datalayerconfig) | Data configures the DataLayer. It is required if the new DataLayer is enabled. |
79-
| `featureGates` | []string | FeatureGates is a set of flags that enable various experimental features with the EPP. |
80-
| `plugins` | [`[]PluginSpec`](#pluginspec) | Plugins is the list of plugins that will be instantiated. |
81-
| `saturationDetector` | [`SaturationDetector`](#saturationdetector) | SaturationDetector when present specifies the configuration of the Saturation detector. |
82-
| `schedulingProfiles` | [`[]SchedulingProfile`](#schedulingprofile) | SchedulingProfiles is the list of named SchedulingProfiles that will be created. |
76+
| Field | Type | Description |
77+
| :------------------- | :------------------------------------------ | :------------------------------------------------------------------------------------------------------- |
78+
| `data` | [`DataLayerConfig`](#datalayerconfig) | Data configures the DataLayer. It is required if the new DataLayer is enabled. |
79+
| `featureGates` | `[]string` | FeatureGates is a set of flags that enable various experimental features with the EPP. |
80+
| `plugins` | [`[]PluginSpec`](#pluginspec) | Plugins is the list of plugins that will be instantiated. See [Plugins](./plugins.mdx) for more details. |
81+
| `saturationDetector` | [`SaturationDetector`](#saturationdetector) | SaturationDetector when present specifies the configuration of the Saturation detector. |
82+
| `schedulingProfiles` | [`[]SchedulingProfile`](#schedulingprofile) | SchedulingProfiles is the list of named SchedulingProfiles that will be created. |
8383

8484
#### PluginSpec
8585

86+
For more details on available plugins, see [Plugins](./plugins.mdx).
87+
8688
| Field | Type | Description |
8789
| :----------- | :------- | :------------------------------------------------------------------------------------------------------------------- |
8890
| `name` | `string` | Name provides a name for plugin entries to reference. If omitted, the value of the Plugin's Type field will be used. |

‎website/package-lock.json‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)