Skip to content

docs: fix versioned docs links #537

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
avinxshKD wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: fix versioned docs links #537

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
003c368
docs: fix versioned docs links
avinxshKD Jun 22, 2026
cf3facc
docs: remove self links in queue docs
avinxshKD Jun 22, 2026
cb66c00
docs: remove stale capacity guide links
avinxshKD Jun 24, 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
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.10.0/Concepts/Queue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ deserved indicates the expected resource amount for all PodGroups in this queue.

> **Note**:
>
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](/docs/UserGuide/user_guide_how_to_use_capacity_plugin)
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](https://github.com/volcano-sh/volcano/blob/v1.10.0/docs/user-guide/how_to_use_capacity_plugin.md)

@JesseStutler JesseStutler Jun 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Quite confused, at least it should link to the user guide for the same version v1.10.0, we currently have a User guide section, not linking to GitHub

> 2. If the allocated resources of a queue exceed its configured deserved value, the queue cannot reclaim resources from other queues

* weight, *optional*
Expand All @@ -78,7 +78,7 @@ priority indicates the priority of this queue. During resource allocation and re

* parent, *optional*

This field is used to configure [hierarchical queues](/docs/KeyFeatures/HierarchicalQueue). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.
This field is used to configure hierarchical queues. parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.

@JesseStutler JesseStutler Jun 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why remove the link? We have such docs under the key featuers, just link to the same version

@avinxshKD avinxshKD Jun 24, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Same here. This version snapshot does not have the KeyFeatures page, so a same-version relative link would be unresolved. Kept it as plain text to avoid jumping to Latest.


## Status
### Open
Expand All @@ -94,6 +94,6 @@ This field is used to configure [hierarchical queues](/docs/KeyFeatures/Hierarch
#### default Queue
When Volcano starts, it automatically creates queue `default` whose `weight` is `1`. Subsequent jobs that are not assigned to a queue will be assigned to queue `default`.
#### root queue
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](/docs/KeyFeatures/HierarchicalQueue) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.
When Volcano starts, it also creates a queue named root by default. This queue is used when the hierarchical queue feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.

> For more information on queue usage scenarios, please refer to [Queue Resource Management](/docs/KeyFeatures/QueueResourceManagement)
> For more information on queue usage scenarios, please refer to Queue Resource Management
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.10.0/Ecosystem/RayOnVolcano.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ ray job submit --address http://localhost:8265 -- python -c "import ray; ray.ini
### Learn More

- For KubeRay integration details, visit the [KubeRay Volcano Scheduler Documentation](https://docs.ray.io/en/latest/cluster/kubernetes/k8s-ecosystem/volcano.html#kuberay-integration-with-volcano)
- For Volcano Job Ray plugin details, see the [Volcano Ray Plugin Guide](/docs/UserGuide/user_guide_how_to_use_ray_plugin)
- For Volcano Job Ray plugin details, see the Volcano Ray Plugin Guide
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.11.0/Concepts/Queue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ deserved indicates the expected resource amount for all PodGroups in this queue.

> **Note**:
>
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](/docs/UserGuide/user_guide_how_to_use_capacity_plugin)
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](https://github.com/volcano-sh/volcano/blob/v1.11.0/docs/user-guide/how_to_use_capacity_plugin.md)
> 2. If the allocated resources of a queue exceed its configured deserved value, the queue cannot reclaim resources from other queues

* weight, *optional*
Expand All @@ -78,7 +78,7 @@ priority indicates the priority of this queue. During resource allocation and re

* parent, *optional*

This field is used to configure [hierarchical queues](/docs/KeyFeatures/HierarchicalQueue). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.
This field is used to configure [hierarchical queues](../KeyFeatures/HierarchicalQueue.md). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.

## Status
### Open
Expand All @@ -94,6 +94,6 @@ This field is used to configure [hierarchical queues](/docs/KeyFeatures/Hierarch
#### default Queue
When Volcano starts, it automatically creates queue `default` whose `weight` is `1`. Subsequent jobs that are not assigned to a queue will be assigned to queue `default`.
#### root queue
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](/docs/KeyFeatures/HierarchicalQueue) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](../KeyFeatures/HierarchicalQueue.md) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.

> For more information on queue usage scenarios, please refer to [Queue Resource Management](/docs/KeyFeatures/QueueResourceManagement)
> For more information on queue usage scenarios, please refer to [Queue Resource Management](../KeyFeatures/QueueResourceManagement.md)
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.11.0/Ecosystem/RayOnVolcano.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ ray job submit --address http://localhost:8265 -- python -c "import ray; ray.ini
### Learn More

- For KubeRay integration details, visit the [KubeRay Volcano Scheduler Documentation](https://docs.ray.io/en/latest/cluster/kubernetes/k8s-ecosystem/volcano.html#kuberay-integration-with-volcano)
- For Volcano Job Ray plugin details, see the [Volcano Ray Plugin Guide](/docs/UserGuide/user_guide_how_to_use_ray_plugin)
- For Volcano Job Ray plugin details, see the Volcano Ray Plugin Guide
6 changes: 3 additions & 3 deletions versioned_docs/version-v1.11.0/Home/Introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Job scheduling and management become increasingly complex and critical for high-

Volcano is designed to cater to these requirements. In addition, Volcano inherits the design of Kubernetes APIs, allowing you to easily run applications that require high-performance computing on Kubernetes.
## Features
### [Unified Scheduling](/docs/KeyFeatures/UnifiedScheduling)
### [Unified Scheduling](../KeyFeatures/UnifiedScheduling.md)
* Support native Kubernetes workload scheduling
* Provide complete support for frameworks like PyTorch, TensorFlow, Spark, Flink, Ray through VolcanoJob
* Unified scheduling for both online microservices and offline batch jobs to improve cluster resource utilization
Expand All @@ -39,7 +39,7 @@ Volcano is designed to cater to these requirements. In addition, Volcano inherit

Volcano supports custom plugins and actions to implement more scheduling algorithms.

### [Queue Resource Management](/docs/KeyFeatures/QueueResourceManagement)
### [Queue Resource Management](../KeyFeatures/QueueResourceManagement.md)
* Support multi-dimensional resource quota control (CPU, Memory, GPU, etc.)
* Provide multi-level queue structure and resource inheritance
* Support resource borrowing, reclaiming and preemption between queues
Expand All @@ -52,7 +52,7 @@ Volcano can schedule computing resources from multiple architectures:
* Arm
* Kunpeng
* Ascend
* GPU: Supports [GPU virtualization](/docs/v1.11.0/KeyFeatures/GPUVirtualization) functionality, providing fine-grained GPU resource management
* GPU: Supports [GPU virtualization](../KeyFeatures/GPUVirtualization.md) functionality, providing fine-grained GPU resource management
* **vGPU Scheduling**: Supports virtualizing single physical GPU into multiple vGPUs for fine-grained GPU resource allocation
* **Memory Isolation**: Supports setting independent memory limits for each vGPU to prevent memory conflicts between tasks
* **Compute Allocation**: Supports allocating GPU by percentage for resource sharing
Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.11.0/KeyFeatures/QueueResourceManagement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ deserved indicates the expected resource amount for all PodGroups in this queue.

> **Note**:
>
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](/docs/UserGuide/user_guide_how_to_use_capacity_plugin)
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](https://github.com/volcano-sh/volcano/blob/v1.11.0/docs/user-guide/how_to_use_capacity_plugin.md)
> 2. If the allocated resources of a queue exceed its configured deserved value, the queue cannot reclaim resources from other queues

* weight, *optional*
Expand All @@ -77,7 +77,7 @@ priority indicates the priority of this queue. During resource allocation and re

* parent, *optional*

This field is used to configure [hierarchical queues](/docs/KeyFeatures/HierarchicalQueue). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.
This field is used to configure [hierarchical queues](HierarchicalQueue.md). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.

## Status
### Open
Expand All @@ -93,6 +93,6 @@ This field is used to configure [hierarchical queues](/docs/KeyFeatures/Hierarch
#### default Queue
When Volcano starts, it automatically creates queue `default` whose `weight` is `1`. Subsequent jobs that are not assigned to a queue will be assigned to queue `default`.
#### root queue
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](/docs/KeyFeatures/HierarchicalQueue) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](HierarchicalQueue.md) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.

> For more information on queue usage scenarios, please refer to [Queue Resource Management](/docs/KeyFeatures/QueueResourceManagement)
> For more information on queue usage scenarios, please refer to [Queue Resource Management](QueueResourceManagement.md)
Comment thread
avinxshKD marked this conversation as resolved.
Outdated
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.12.0/Concepts/Queue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ deserved indicates the expected resource amount for all PodGroups in this queue.

> **Note**:
>
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](/docs/UserGuide/user_guide_how_to_use_capacity_plugin)
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](https://github.com/volcano-sh/volcano/blob/v1.12.0/docs/user-guide/how_to_use_capacity_plugin.md)
> 2. If the allocated resources of a queue exceed its configured deserved value, the queue cannot reclaim resources from other queues

* weight, *optional*
Expand All @@ -78,7 +78,7 @@ priority indicates the priority of this queue. During resource allocation and re

* parent, *optional*

This field is used to configure [hierarchical queues](/docs/KeyFeatures/HierarchicalQueue). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.
This field is used to configure [hierarchical queues](../KeyFeatures/HierarchicalQueue.md). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.

## Status
### Open
Expand All @@ -94,6 +94,6 @@ This field is used to configure [hierarchical queues](/docs/KeyFeatures/Hierarch
#### default Queue
When Volcano starts, it automatically creates queue `default` whose `weight` is `1`. Subsequent jobs that are not assigned to a queue will be assigned to queue `default`.
#### root queue
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](/docs/KeyFeatures/HierarchicalQueue) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](../KeyFeatures/HierarchicalQueue.md) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.

> For more information on queue usage scenarios, please refer to [Queue Resource Management](/docs/KeyFeatures/QueueResourceManagement)
> For more information on queue usage scenarios, please refer to [Queue Resource Management](../KeyFeatures/QueueResourceManagement.md)
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.12.0/Ecosystem/RayOnVolcano.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ ray job submit --address http://localhost:8265 -- python -c "import ray; ray.ini
### Learn More

- For KubeRay integration details, visit the [KubeRay Volcano Scheduler Documentation](https://docs.ray.io/en/latest/cluster/kubernetes/k8s-ecosystem/volcano.html#kuberay-integration-with-volcano)
- For Volcano Job Ray plugin details, see the [Volcano Ray Plugin Guide](/docs/UserGuide/user_guide_how_to_use_ray_plugin)
- For Volcano Job Ray plugin details, see the Volcano Ray Plugin Guide
6 changes: 3 additions & 3 deletions versioned_docs/version-v1.12.0/Home/Introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Job scheduling and management become increasingly complex and critical for high-

Volcano is designed to cater to these requirements. In addition, Volcano inherits the design of Kubernetes APIs, allowing you to easily run applications that require high-performance computing on Kubernetes.
## Features
### [Unified Scheduling](/docs/KeyFeatures/UnifiedScheduling)
### [Unified Scheduling](../KeyFeatures/UnifiedScheduling.md)
* Support native Kubernetes workload scheduling
* Provide complete support for frameworks like PyTorch, TensorFlow, Spark, Flink, Ray through VolcanoJob
* Unified scheduling for both online microservices and offline batch jobs to improve cluster resource utilization
Expand All @@ -39,7 +39,7 @@ Volcano is designed to cater to these requirements. In addition, Volcano inherit

Volcano supports custom plugins and actions to implement more scheduling algorithms.

### [Queue Resource Management](/docs/KeyFeatures/QueueResourceManagement)
### [Queue Resource Management](../KeyFeatures/QueueResourceManagement.md)
* Support multi-dimensional resource quota control (CPU, Memory, GPU, etc.)
* Provide multi-level queue structure and resource inheritance
* Support resource borrowing, reclaiming and preemption between queues
Expand All @@ -52,7 +52,7 @@ Volcano can schedule computing resources from multiple architectures:
* Arm
* Kunpeng
* Ascend
* GPU: Supports multiple [GPU virtualization](/docs/KeyFeatures/GPUVirtualization) technologies for flexible resource management
* GPU: Supports multiple [GPU virtualization](../KeyFeatures/GPUVirtualization.md) technologies for flexible resource management
* **Dynamic MIG Support**: Enables dynamic partitioning of NVIDIA Multi-Instance GPUs (MIG), providing hardware-level isolation to segment a physical GPU into multiple independent instances
* **vCUDA Virtualization**: Virtualizes physical GPUs into multiple vGPU devices at the software level for resource sharing and isolation
* **Fine-Grained Resource Control**: Provides dedicated memory and compute allocation for each GPU instance
Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.12.0/KeyFeatures/QueueResourceManagement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ deserved indicates the expected resource amount for all PodGroups in this queue.

> **Note**:
>
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](/docs/UserGuide/user_guide_how_to_use_capacity_plugin)
> 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](https://github.com/volcano-sh/volcano/blob/v1.12.0/docs/user-guide/how_to_use_capacity_plugin.md)
> 2. If the allocated resources of a queue exceed its configured deserved value, the queue cannot reclaim resources from other queues

* weight, *optional*
Expand All @@ -77,7 +77,7 @@ priority indicates the priority of this queue. During resource allocation and re

* parent, *optional*

This field is used to configure [hierarchical queues](/docs/KeyFeatures/HierarchicalQueue). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.
This field is used to configure [hierarchical queues](HierarchicalQueue.md). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default.

## Status
### Open
Expand All @@ -93,6 +93,6 @@ This field is used to configure [hierarchical queues](/docs/KeyFeatures/Hierarch
#### default Queue
When Volcano starts, it automatically creates queue `default` whose `weight` is `1`. Subsequent jobs that are not assigned to a queue will be assigned to queue `default`.
#### root queue
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](/docs/KeyFeatures/HierarchicalQueue) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.
When Volcano starts, it also creates a queue named root by default. This queue is used when the [hierarchical queue](HierarchicalQueue.md) feature is enabled, serving as the root queue for all queues, with the default queue being a child queue of the root queue.

> For more information on queue usage scenarios, please refer to [Queue Resource Management](/docs/KeyFeatures/QueueResourceManagement)
> For more information on queue usage scenarios, please refer to [Queue Resource Management](QueueResourceManagement.md)
Comment thread
avinxshKD marked this conversation as resolved.
Outdated
Loading