From 8bf17bcbe68884c4f19d33189f6647d0b10e08e8 Mon Sep 17 00:00:00 2001 From: mesutoezdil Date: Wed, 6 May 2026 22:15:22 +0200 Subject: [PATCH] docs: remove filler words from versioned doc snapshots Remove 'simply', 'let's', and 'leverage' from historical doc snapshots (v1.3.0 through v2.8.0). - dynamic-mig-support.md: drop 'simply' before 'by specifying' (7 files) - contributing.md: 'called simply "PR"' -> 'called PRs' (7 files) - contribute-docs.md: 'let's take a look' -> 'Here is a quick example' (6 files) - faq.md: 'leverage HAMi's GPU isolation' -> 'use HAMi's GPU isolation' (3 files) Signed-off-by: mesutoezdil --- versioned_docs/version-v1.3.0/contributor/contributing.md | 2 +- .../userguide/nvidia-device/dynamic-mig-support.md | 2 +- versioned_docs/version-v2.4.1/contributor/contribute-docs.md | 2 +- versioned_docs/version-v2.4.1/contributor/contributing.md | 2 +- .../userguide/nvidia-device/dynamic-mig-support.md | 2 +- versioned_docs/version-v2.5.0/contributor/contribute-docs.md | 2 +- versioned_docs/version-v2.5.0/contributor/contributing.md | 2 +- .../userguide/nvidia-device/dynamic-mig-support.md | 2 +- versioned_docs/version-v2.5.1/contributor/contribute-docs.md | 2 +- versioned_docs/version-v2.5.1/contributor/contributing.md | 2 +- .../userguide/nvidia-device/dynamic-mig-support.md | 2 +- versioned_docs/version-v2.6.0/contributor/contribute-docs.md | 2 +- versioned_docs/version-v2.6.0/contributor/contributing.md | 2 +- versioned_docs/version-v2.6.0/faq/faq.md | 2 +- .../userguide/nvidia-device/dynamic-mig-support.md | 2 +- versioned_docs/version-v2.7.0/contributor/contribute-docs.md | 2 +- versioned_docs/version-v2.7.0/contributor/contributing.md | 2 +- versioned_docs/version-v2.7.0/faq/faq.md | 2 +- .../userguide/nvidia-device/dynamic-mig-support.md | 2 +- versioned_docs/version-v2.8.0/contributor/contribute-docs.md | 2 +- versioned_docs/version-v2.8.0/contributor/contributing.md | 2 +- versioned_docs/version-v2.8.0/faq/faq.md | 2 +- .../userguide/nvidia-device/dynamic-mig-support.md | 2 +- 23 files changed, 23 insertions(+), 23 deletions(-) diff --git a/versioned_docs/version-v1.3.0/contributor/contributing.md b/versioned_docs/version-v1.3.0/contributor/contributing.md index 348e5b10..fab6d31c 100644 --- a/versioned_docs/version-v1.3.0/contributor/contributing.md +++ b/versioned_docs/version-v1.3.0/contributor/contributing.md @@ -71,7 +71,7 @@ This is a rough outline of what a contributor's workflow looks like: ## Creating Pull Requests -Pull requests are often called simply "PR". +Pull requests are often called PRs. HAMi generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process. To submit a proposed change, please develop the code/fix and add new test cases. After that, run these local verifications before submitting pull request to predict the pass or diff --git a/versioned_docs/version-v1.3.0/userguide/nvidia-device/dynamic-mig-support.md b/versioned_docs/version-v1.3.0/userguide/nvidia-device/dynamic-mig-support.md index 4a259004..13dd62d1 100644 --- a/versioned_docs/version-v1.3.0/userguide/nvidia-device/dynamic-mig-support.md +++ b/versioned_docs/version-v1.3.0/userguide/nvidia-device/dynamic-mig-support.md @@ -137,7 +137,7 @@ You can customize the mig configuration by following the steps below: ## Running MIG jobs MIG instance can now be requested by a container the same way as using `hami-core` -simply by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource type. +by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource type. ```yaml apiVersion: v1 diff --git a/versioned_docs/version-v2.4.1/contributor/contribute-docs.md b/versioned_docs/version-v2.4.1/contributor/contribute-docs.md index 26a8eab4..5fe0302e 100644 --- a/versioned_docs/version-v2.4.1/contributor/contribute-docs.md +++ b/versioned_docs/version-v2.4.1/contributor/contribute-docs.md @@ -75,7 +75,7 @@ Contributors mainly contribute documentation to the current version. It's important for your article to specify metadata concerning an article at the top of the Markdown file, in a section called **Front Matter**. -For now, let's take a look at a quick example which should explain the most relevant entries in **Front Matter**: +Here is a quick example that explains the most relevant entries in **Front Matter**: ```yaml --- diff --git a/versioned_docs/version-v2.4.1/contributor/contributing.md b/versioned_docs/version-v2.4.1/contributor/contributing.md index 348e5b10..fab6d31c 100644 --- a/versioned_docs/version-v2.4.1/contributor/contributing.md +++ b/versioned_docs/version-v2.4.1/contributor/contributing.md @@ -71,7 +71,7 @@ This is a rough outline of what a contributor's workflow looks like: ## Creating Pull Requests -Pull requests are often called simply "PR". +Pull requests are often called PRs. HAMi generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process. To submit a proposed change, please develop the code/fix and add new test cases. After that, run these local verifications before submitting pull request to predict the pass or diff --git a/versioned_docs/version-v2.4.1/userguide/nvidia-device/dynamic-mig-support.md b/versioned_docs/version-v2.4.1/userguide/nvidia-device/dynamic-mig-support.md index 4a259004..13dd62d1 100644 --- a/versioned_docs/version-v2.4.1/userguide/nvidia-device/dynamic-mig-support.md +++ b/versioned_docs/version-v2.4.1/userguide/nvidia-device/dynamic-mig-support.md @@ -137,7 +137,7 @@ You can customize the mig configuration by following the steps below: ## Running MIG jobs MIG instance can now be requested by a container the same way as using `hami-core` -simply by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource type. +by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource type. ```yaml apiVersion: v1 diff --git a/versioned_docs/version-v2.5.0/contributor/contribute-docs.md b/versioned_docs/version-v2.5.0/contributor/contribute-docs.md index 1aadc102..f095e61a 100644 --- a/versioned_docs/version-v2.5.0/contributor/contribute-docs.md +++ b/versioned_docs/version-v2.5.0/contributor/contribute-docs.md @@ -77,7 +77,7 @@ Contributors mainly contribute documentation to the current version. It's important for your article to specify metadata concerning an article at the top of the Markdown file, in a section called **Front Matter**. -For now, let's take a look at a quick example which should explain the most relevant entries in **Front Matter**: +Here is a quick example that explains the most relevant entries in **Front Matter**: ```yaml --- diff --git a/versioned_docs/version-v2.5.0/contributor/contributing.md b/versioned_docs/version-v2.5.0/contributor/contributing.md index 348e5b10..fab6d31c 100644 --- a/versioned_docs/version-v2.5.0/contributor/contributing.md +++ b/versioned_docs/version-v2.5.0/contributor/contributing.md @@ -71,7 +71,7 @@ This is a rough outline of what a contributor's workflow looks like: ## Creating Pull Requests -Pull requests are often called simply "PR". +Pull requests are often called PRs. HAMi generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process. To submit a proposed change, please develop the code/fix and add new test cases. After that, run these local verifications before submitting pull request to predict the pass or diff --git a/versioned_docs/version-v2.5.0/userguide/nvidia-device/dynamic-mig-support.md b/versioned_docs/version-v2.5.0/userguide/nvidia-device/dynamic-mig-support.md index 4a259004..13dd62d1 100644 --- a/versioned_docs/version-v2.5.0/userguide/nvidia-device/dynamic-mig-support.md +++ b/versioned_docs/version-v2.5.0/userguide/nvidia-device/dynamic-mig-support.md @@ -137,7 +137,7 @@ You can customize the mig configuration by following the steps below: ## Running MIG jobs MIG instance can now be requested by a container the same way as using `hami-core` -simply by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource type. +by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource type. ```yaml apiVersion: v1 diff --git a/versioned_docs/version-v2.5.1/contributor/contribute-docs.md b/versioned_docs/version-v2.5.1/contributor/contribute-docs.md index 1aadc102..f095e61a 100644 --- a/versioned_docs/version-v2.5.1/contributor/contribute-docs.md +++ b/versioned_docs/version-v2.5.1/contributor/contribute-docs.md @@ -77,7 +77,7 @@ Contributors mainly contribute documentation to the current version. It's important for your article to specify metadata concerning an article at the top of the Markdown file, in a section called **Front Matter**. -For now, let's take a look at a quick example which should explain the most relevant entries in **Front Matter**: +Here is a quick example that explains the most relevant entries in **Front Matter**: ```yaml --- diff --git a/versioned_docs/version-v2.5.1/contributor/contributing.md b/versioned_docs/version-v2.5.1/contributor/contributing.md index 348e5b10..fab6d31c 100644 --- a/versioned_docs/version-v2.5.1/contributor/contributing.md +++ b/versioned_docs/version-v2.5.1/contributor/contributing.md @@ -71,7 +71,7 @@ This is a rough outline of what a contributor's workflow looks like: ## Creating Pull Requests -Pull requests are often called simply "PR". +Pull requests are often called PRs. HAMi generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process. To submit a proposed change, please develop the code/fix and add new test cases. After that, run these local verifications before submitting pull request to predict the pass or diff --git a/versioned_docs/version-v2.5.1/userguide/nvidia-device/dynamic-mig-support.md b/versioned_docs/version-v2.5.1/userguide/nvidia-device/dynamic-mig-support.md index 4d208842..bea5435b 100644 --- a/versioned_docs/version-v2.5.1/userguide/nvidia-device/dynamic-mig-support.md +++ b/versioned_docs/version-v2.5.1/userguide/nvidia-device/dynamic-mig-support.md @@ -136,7 +136,7 @@ Please note that HAMi will identify and use the first MIG template that matches ## Running MIG jobs A MIG instance can now be requested by a container in the same way as `hami-core`, -simply by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. +by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. ```yaml apiVersion: v1 diff --git a/versioned_docs/version-v2.6.0/contributor/contribute-docs.md b/versioned_docs/version-v2.6.0/contributor/contribute-docs.md index 1aadc102..f095e61a 100644 --- a/versioned_docs/version-v2.6.0/contributor/contribute-docs.md +++ b/versioned_docs/version-v2.6.0/contributor/contribute-docs.md @@ -77,7 +77,7 @@ Contributors mainly contribute documentation to the current version. It's important for your article to specify metadata concerning an article at the top of the Markdown file, in a section called **Front Matter**. -For now, let's take a look at a quick example which should explain the most relevant entries in **Front Matter**: +Here is a quick example that explains the most relevant entries in **Front Matter**: ```yaml --- diff --git a/versioned_docs/version-v2.6.0/contributor/contributing.md b/versioned_docs/version-v2.6.0/contributor/contributing.md index 4a4f6bec..32af0a21 100644 --- a/versioned_docs/version-v2.6.0/contributor/contributing.md +++ b/versioned_docs/version-v2.6.0/contributor/contributing.md @@ -71,7 +71,7 @@ This is a rough outline of what a contributor's workflow looks like: ## Creating Pull Requests -Pull requests are often called simply "PR". +Pull requests are often called PRs. HAMi generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process. To submit a proposed change, please develop the code/fix and add new test cases. After that, run these local verifications before submitting pull request to predict the pass or diff --git a/versioned_docs/version-v2.6.0/faq/faq.md b/versioned_docs/version-v2.6.0/faq/faq.md index b2115d8e..6a9b72f4 100644 --- a/versioned_docs/version-v2.6.0/faq/faq.md +++ b/versioned_docs/version-v2.6.0/faq/faq.md @@ -70,7 +70,7 @@ In summary, while HAMi's own priority serves a different, device-specific purpos **Currently Supported**: - **Volcano**: Can be integrated with Volcano by using the [`volcano-vgpu-device-plugin`](https://github.com/Project-HAMi/volcano-vgpu-device-plugin) under the HAMi project for GPU resource scheduling and management. -- **Koordinator**: HAMi can also be integrated with Koordinator to provide end-to-end GPU sharing solutions. By deploying HAMi-core on nodes and configuring the appropriate labels and resource requests in Pods, Koordinator can leverage HAMi’s GPU isolation capabilities, allowing multiple Pods to share the same GPU and significantly improve GPU resource utilization. +- **Koordinator**: HAMi can also be integrated with Koordinator to provide end-to-end GPU sharing solutions. By deploying HAMi-core on nodes and configuring the appropriate labels and resource requests in Pods, Koordinator can use HAMi’s GPU isolation capabilities, allowing multiple Pods to share the same GPU and significantly improve GPU resource utilization. For detailed configuration and usage instructions, refer to the Koordinator documentation: [Device Scheduling - GPU Share With HAMi](https://koordinator.sh/docs/user-manuals/device-scheduling-gpu-share-with-hami/) diff --git a/versioned_docs/version-v2.6.0/userguide/nvidia-device/dynamic-mig-support.md b/versioned_docs/version-v2.6.0/userguide/nvidia-device/dynamic-mig-support.md index 4d208842..bea5435b 100644 --- a/versioned_docs/version-v2.6.0/userguide/nvidia-device/dynamic-mig-support.md +++ b/versioned_docs/version-v2.6.0/userguide/nvidia-device/dynamic-mig-support.md @@ -136,7 +136,7 @@ Please note that HAMi will identify and use the first MIG template that matches ## Running MIG jobs A MIG instance can now be requested by a container in the same way as `hami-core`, -simply by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. +by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. ```yaml apiVersion: v1 diff --git a/versioned_docs/version-v2.7.0/contributor/contribute-docs.md b/versioned_docs/version-v2.7.0/contributor/contribute-docs.md index 6cee70c9..58f4b0d4 100644 --- a/versioned_docs/version-v2.7.0/contributor/contribute-docs.md +++ b/versioned_docs/version-v2.7.0/contributor/contribute-docs.md @@ -77,7 +77,7 @@ Contributors mainly contribute documentation to the current version. It's important for your article to specify metadata concerning an article at the top of the Markdown file, in a section called **Front Matter**. -For now, let's take a look at a quick example which should explain the most relevant entries in **Front Matter**: +Here is a quick example that explains the most relevant entries in **Front Matter**: ```yaml --- diff --git a/versioned_docs/version-v2.7.0/contributor/contributing.md b/versioned_docs/version-v2.7.0/contributor/contributing.md index 348e5b10..fab6d31c 100644 --- a/versioned_docs/version-v2.7.0/contributor/contributing.md +++ b/versioned_docs/version-v2.7.0/contributor/contributing.md @@ -71,7 +71,7 @@ This is a rough outline of what a contributor's workflow looks like: ## Creating Pull Requests -Pull requests are often called simply "PR". +Pull requests are often called PRs. HAMi generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process. To submit a proposed change, please develop the code/fix and add new test cases. After that, run these local verifications before submitting pull request to predict the pass or diff --git a/versioned_docs/version-v2.7.0/faq/faq.md b/versioned_docs/version-v2.7.0/faq/faq.md index a985dca9..067ca2b8 100644 --- a/versioned_docs/version-v2.7.0/faq/faq.md +++ b/versioned_docs/version-v2.7.0/faq/faq.md @@ -70,7 +70,7 @@ In summary, while HAMi's own priority serves a different, device-specific purpos **Currently Supported**: - **Volcano**: Can be integrated with Volcano by using the [`volcano-vgpu-device-plugin`](https://github.com/Project-HAMi/volcano-vgpu-device-plugin) under the HAMi project for GPU resource scheduling and management. -- **Koordinator**: HAMi can also be integrated with Koordinator to provide end-to-end GPU sharing solutions. By deploying HAMi-core on nodes and configuring the appropriate labels and resource requests in Pods, Koordinator can leverage HAMi’s GPU isolation capabilities, allowing multiple Pods to share the same GPU and significantly improve GPU resource utilization. +- **Koordinator**: HAMi can also be integrated with Koordinator to provide end-to-end GPU sharing solutions. By deploying HAMi-core on nodes and configuring the appropriate labels and resource requests in Pods, Koordinator can use HAMi’s GPU isolation capabilities, allowing multiple Pods to share the same GPU and significantly improve GPU resource utilization. For detailed configuration and usage instructions, refer to the Koordinator documentation: [Device Scheduling - GPU Share With HAMi](https://koordinator.sh/docs/user-manuals/device-scheduling-gpu-share-with-hami/) diff --git a/versioned_docs/version-v2.7.0/userguide/nvidia-device/dynamic-mig-support.md b/versioned_docs/version-v2.7.0/userguide/nvidia-device/dynamic-mig-support.md index 4d208842..bea5435b 100644 --- a/versioned_docs/version-v2.7.0/userguide/nvidia-device/dynamic-mig-support.md +++ b/versioned_docs/version-v2.7.0/userguide/nvidia-device/dynamic-mig-support.md @@ -136,7 +136,7 @@ Please note that HAMi will identify and use the first MIG template that matches ## Running MIG jobs A MIG instance can now be requested by a container in the same way as `hami-core`, -simply by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. +by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. ```yaml apiVersion: v1 diff --git a/versioned_docs/version-v2.8.0/contributor/contribute-docs.md b/versioned_docs/version-v2.8.0/contributor/contribute-docs.md index a71ad911..179e55a8 100644 --- a/versioned_docs/version-v2.8.0/contributor/contribute-docs.md +++ b/versioned_docs/version-v2.8.0/contributor/contribute-docs.md @@ -77,7 +77,7 @@ Contributors mainly contribute documentation to the current version. It's important for your article to specify metadata concerning an article at the top of the Markdown file, in a section called **Front Matter**. -For now, let's take a look at a quick example which should explain the most relevant entries in **Front Matter**: +Here is a quick example that explains the most relevant entries in **Front Matter**: ```markdown --- diff --git a/versioned_docs/version-v2.8.0/contributor/contributing.md b/versioned_docs/version-v2.8.0/contributor/contributing.md index 348e5b10..fab6d31c 100644 --- a/versioned_docs/version-v2.8.0/contributor/contributing.md +++ b/versioned_docs/version-v2.8.0/contributor/contributing.md @@ -71,7 +71,7 @@ This is a rough outline of what a contributor's workflow looks like: ## Creating Pull Requests -Pull requests are often called simply "PR". +Pull requests are often called PRs. HAMi generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process. To submit a proposed change, please develop the code/fix and add new test cases. After that, run these local verifications before submitting pull request to predict the pass or diff --git a/versioned_docs/version-v2.8.0/faq/faq.md b/versioned_docs/version-v2.8.0/faq/faq.md index 0e2b401d..f5ee5c04 100644 --- a/versioned_docs/version-v2.8.0/faq/faq.md +++ b/versioned_docs/version-v2.8.0/faq/faq.md @@ -69,7 +69,7 @@ In summary, while HAMi's own priority serves a different, device-specific purpos **Currently Supported**: - **Volcano**: Can be integrated with Volcano by using the [`volcano-vgpu-device-plugin`](https://github.com/Project-HAMi/volcano-vgpu-device-plugin) under the HAMi project for GPU resource scheduling and management. -- **Koordinator**: HAMi can also be integrated with Koordinator to provide end-to-end GPU sharing solutions. By deploying HAMi-core on nodes and configuring the appropriate labels and resource requests in Pods, Koordinator can leverage HAMi’s GPU isolation capabilities, allowing multiple Pods to share the same GPU and significantly improve GPU resource utilization. +- **Koordinator**: HAMi can also be integrated with Koordinator to provide end-to-end GPU sharing solutions. By deploying HAMi-core on nodes and configuring the appropriate labels and resource requests in Pods, Koordinator can use HAMi’s GPU isolation capabilities, allowing multiple Pods to share the same GPU and significantly improve GPU resource utilization. For detailed configuration and usage instructions, refer to the Koordinator documentation: [Device Scheduling - GPU Share With HAMi](https://koordinator.sh/docs/user-manuals/device-scheduling-gpu-share-with-hami/) diff --git a/versioned_docs/version-v2.8.0/userguide/nvidia-device/dynamic-mig-support.md b/versioned_docs/version-v2.8.0/userguide/nvidia-device/dynamic-mig-support.md index 4d208842..bea5435b 100644 --- a/versioned_docs/version-v2.8.0/userguide/nvidia-device/dynamic-mig-support.md +++ b/versioned_docs/version-v2.8.0/userguide/nvidia-device/dynamic-mig-support.md @@ -136,7 +136,7 @@ Please note that HAMi will identify and use the first MIG template that matches ## Running MIG jobs A MIG instance can now be requested by a container in the same way as `hami-core`, -simply by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. +by specifying the `nvidia.com/gpu` and `nvidia.com/gpumem` resource types. ```yaml apiVersion: v1