Skip to content

Commit 9f296bc

Browse files
committed
Fix: Combine three-level dropdown with stutter bug fixes
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
2 parents a7d13f3 + ce8a2ab commit 9f296bc

File tree

45 files changed

+5157
-61
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+5157
-61
lines changed

README.md

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Netlify Status](https://api.netlify.com/api/v1/badges/8cf65901-dae4-4826-b32b-17feeebddc86/deploy-status)](https://app.netlify.com/sites/kind-montalcini-bed86a/deploys)
22

3+
# Creating and updating the docs
34

4-
# Creating and updating the docs
55
Welcome to the GitHub repository for Volcano's public website. The docs are
66
hosted at https://volcano.sh.
77

@@ -11,7 +11,7 @@ is an open-source static site generator that provides us with templates, content
1111
organisation in a standard directory structure, and a website generation engine.
1212
You write the pages in Markdown, and Hugo wraps them up into a website.
1313

14-
* Please see [How to contributing](https://github.com/volcano-sh/volcano/blob/master/contribute.md) for instructions on how to contribute, if you are not familiar with the
14+
* Please see [How to contribute](https://github.com/volcano-sh/volcano/blob/master/contribute.md) for instructions on how to contribute, if you are not familiar with the
1515
GitHub workflow
1616

1717
## Quickstart
@@ -21,19 +21,19 @@ GitHub workflow and you're happy to use the automated preview of your doc
2121
updates:
2222

2323
1. Fork the repo on GitHub.
24-
1. Make your changes and send a pull request (PR).
25-
1. If you're not yet ready for a review, add a comment to the PR saying it's a
26-
work in progress or add `[WIP]` in your PRs title. You can also add `/hold` in a comment to mark the PR as not
27-
ready for merge. (**Don't** add the Hugo declarative "draft = true" to the
28-
page front matter, because that will prevent the auto-deployment of the
29-
content preview described in the next point.)
30-
1. Wait for the automated PR workflow to do some checks. When it's ready,
31-
you should see a comment like this: **deploy/netlify — Deploy preview ready!**
32-
1. Click **Details** to the right of "Deploy preview ready" to see a preview
33-
of your updates.
34-
1. Continue updating your doc until you're happy with it.
35-
1. When you're ready for a review, add a comment to the PR and assign a
36-
reviewer/approver.
24+
2. Make your changes and send a pull request (PR).
25+
3. If you're not yet ready for a review, add a comment to the PR saying it's a
26+
work in progress or add `[WIP]` in your PRs title. You can also add `/hold` in a comment to mark the PR as not
27+
ready for merge. (**Don't** add the Hugo declarative "draft = true" to the
28+
page front matter, because that will prevent the auto-deployment of the
29+
content preview described in the next point.)
30+
4. Wait for the automated PR workflow to do some checks. When it's ready,
31+
you should see a comment like this: **deploy/netlify — Deploy preview ready!**
32+
5. Click **Details** to the right of "Deploy preview ready" to see a preview
33+
of your updates.
34+
6. Continue updating your doc until you're happy with it.
35+
7. When you're ready for a review, add a comment to the PR and assign a
36+
reviewer/approver.
3737

3838
## Previewing your changes on a local website server
3939

@@ -46,7 +46,7 @@ See the [Hugo installation guide][hugo-install]. Here are some examples:
4646

4747
#### Mac OS X:
4848

49-
```
49+
```bash
5050
brew install hugo
5151
```
5252

@@ -55,17 +55,17 @@ brew install hugo
5555
1. Download the Debian package from the [Hugo website][hugo-install].
5656
Make sure to install the Hugo version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L6) file.
5757
For example, [hugo_0.57.2_Linux-64bit.deb][hugo_0.57.2_Linux-64bit.deb].
58-
1. Install the package using `dpkg`:
58+
2. Install the package using `dpkg`:
5959

60-
```
61-
sudo dpkg -i hugo_0.57.2_Linux-64bit.deb
62-
```
60+
```bash
61+
sudo dpkg -i hugo_0.57.2_Linux-64bit.deb
62+
```
6363

64-
1. Verify your installation:
64+
3. Verify your installation:
6565

66-
```
67-
hugo version
68-
```
66+
```bash
67+
hugo version
68+
```
6969

7070
### Run a local website server
7171

@@ -74,33 +74,34 @@ local machine, then use your local repo as input to your Hugo web server:
7474

7575
1. Ensure you are in your target branch:
7676

77-
```
78-
git branch
79-
```
77+
```bash
78+
git branch
79+
```
8080

81-
1. Start your website server. Make sure you run this command from the
81+
2. Start your website server. Make sure you run this command from the
8282
`/website/` directory, so that Hugo can find the config files it needs:
8383

84-
```
85-
hugo server -D
86-
```
84+
```bash
85+
hugo server -D
86+
```
8787

88-
1. Your website is at [http://localhost:1313/](http://localhost:1313/).
88+
3. Your website is at [http://localhost:1313/](http://localhost:1313/).
8989

90-
1. Continue with the usual GitHub workflow to edit files, commit them, push the
91-
changes up to your fork, and create a pull request. (See the GitHub workflow)
90+
4. Continue with the usual GitHub workflow to edit files, commit them, push the
91+
changes up to your fork, and create a pull request. See [GitHub's documentation on creating pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for more details.
9292

93-
1. While making the changes, you can preview them on your local version of the
94-
website at [http://localhost:1313/](http://localhost:1313/). Note that if you
95-
have more than one local git branch, when you switch between git branches the
96-
local website reflects the files in the current branch.
93+
5. While making the changes, you can preview them on your local version of the
94+
website at [http://localhost:1313/](http://localhost:1313/). Note that if you
95+
have more than one local git branch, when you switch between git branches the
96+
local website reflects the files in the current branch.
9797

9898
Useful Hugo docs:
99+
99100
- [Hugo installation guide](https://gohugo.io/getting-started/installing/)
100101
- [Hugo basic usage](https://gohugo.io/getting-started/usage/)
101102
- [Hugo site directory structure](https://gohugo.io/getting-started/directory-structure/)
102103
- [hugo server reference](https://gohugo.io/commands/hugo_server/)
103104
- [hugo new reference](https://gohugo.io/commands/hugo_new/)
104105

105106
[hugo-install]: https://gohugo.io/getting-started/installing/
106-
[hugo_0.57.2_Linux-64bit.deb]: https://github.com/gohugoio/hugo/releases/download/v0.57.2/hugo_0.57.2_Linux-64bit.deb
107+
[hugo_0.57.2_Linux-64bit.deb]: https://github.com/gohugoio/hugo/releases/download/v0.57.2/hugo_0.57.2_Linux-64bit.deb

config/_default/menus.toml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,26 +73,33 @@
7373
weight = 4
7474
identifier = "features"
7575

76+
[[docs]]
77+
name = "User Guide"
78+
weight = 5
79+
identifier = "user-guide"
80+
url = "/en/docs/user-guide/"
81+
7682
[[docs]]
7783
name = "Ecosystem"
78-
weight = 5
84+
weight = 6
7985
identifier = "ecosystem"
8086

8187
[[docs]]
8288
name = "Scheduler"
83-
weight = 6
89+
weight = 7
8490
identifier = "scheduler"
8591

8692
[[docs]]
8793
name = "CLI"
88-
weight = 7
94+
weight = 8
8995
identifier = "cli"
9096

9197
[[docs]]
9298
name = "Contribution"
93-
weight = 8
99+
weight = 9
94100
identifier = "contribution"
95101

102+
96103
# Documentation version v1.12.0
97104

98105
[[v1-12-0]]

content/en/docs/user_guide.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
+++
2+
title = "User Guide"
3+
weight = 9
4+
type = "docs"
5+
date = 2026-02-03
6+
url = "/en/docs/user-guide/"
7+
+++
8+
9+
This section contains the User Guide for Volcano.
10+
11+
* [Ascend vNPU User Guide](/en/docs/user-guide/how_to_use_vnpu/)
12+
* [Capacity Plugin User Guide](/en/docs/user-guide/how_to_use_capacity_plugin/)
13+
* [Cooldown Protection Plugin User Guide](/en/docs/user-guide/how_to_use_cdp_plugin/)
14+
* [Extender User Guide](/en/docs/user-guide/how_to_use_extender/)
15+
* [GPU Number User Guide](/en/docs/user-guide/how_to_use_gpu_number/)
16+
* [GPU Sharing User Guide](/en/docs/user-guide/how_to_use_gpu_sharing/)
17+
* [How to Configure Scheduler](/en/docs/user-guide/how_to_configure_scheduler/)
18+
* [Volcano Job Policy User Guide](/en/docs/user-guide/how_to_use_job_policy/)
19+
* [Volcano Job Time to Live User Guide](/en/docs/user-guide/how_to_use_job_ttl/)
20+
* [Dynamic Resource Allocation (DRA) User Guide](/en/docs/user-guide/how_to_enable_dra/)
21+
* [How to Tune Volcano Performance in Large-Scale Scenarios](/en/docs/user-guide/how_to_tune_volcano_performance/)
22+
* [How to configure priorityclass for job](/en/docs/user-guide/how_to_configure_priorityclass_for_job/)
23+
* [MPI Plugin User Guide](/en/docs/user-guide/how_to_use_mpi_plugin/)
24+
* [NUMA Aware User Guide](/en/docs/user-guide/how_to_use_numa_aware/)
25+
* [Network Topology Aware Scheduling User Guide](/en/docs/user-guide/how_to_use_network_topology_aware_scheduling/)
26+
* [Nodegroup Plugin User Guide](/en/docs/user-guide/how_to_use_nodegroup_plugin/)
27+
* [Pytorch Plugin User Guide](/en/docs/user-guide/how_to_use_pytorch_plugin/)
28+
* [Ray Plugin User Guide](/en/docs/user-guide/how_to_use_ray_plugin/)
29+
* [Resource Strategy Fit Plugin User Guide](/en/docs/user-guide/how_to_use_resource_strategy_fit_plugin/)
30+
* [Task Topology Plugin User Guide](/en/docs/user-guide/how_to_use_task_topology_plugin/)
31+
* [HyperNode Auto Discovery User Guide](/en/docs/user-guide/how_to_use_hypernode_auto_discovery/)
32+
* [Volcano Job Plugin -- Env User Guide](/en/docs/user-guide/how_to_use_env_plugin/)
33+
* [Volcano Job Plugin -- SSH User Guide](/en/docs/user-guide/how_to_use_ssh_plugin/)
34+
* [Volcano Job Plugin -- SVC User Guide](/en/docs/user-guide/how_to_use_svc_plugin/)
35+
* [Volcano vGPU User Guide](/en/docs/user-guide/how_to_use_volcano_vgpu/)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
+++
2+
title = "How to configure priorityclass for job"
3+
date = 2026-02-03
4+
type = "docs"
5+
weight = 50
6+
url = "/en/docs/user-guide/how_to_configure_priorityclass_for_job/"
7+
[menu.docs]
8+
parent = "user-guide"
9+
+++
10+
11+
12+
## Background
13+
When a user creates a job, if there is no `PriorityClassName` specified in the template of the task, the task will use the `PriorityClassName` specified by the job. The user can specify `PriorityClassName` in each task's template to override the configuration of job, so that priority can be configured separately for each task.
14+
15+
## Key Points
16+
- If the task does not specify `PriorityClassName` but the job does, the task will use the job's PriorityClass, and the `PreemptionPolicy` and priority value will also be the same as the job.
17+
- When user needs to allow task in job to preempt other tasks if the resources are insufficient, a separate `PriorityClassName` must be set in the task's template, and **it is important to note that if there are multiple tasks that need to be set to different priorities, then user need to set the `PriorityClassName` for all of them**, otherwise the task that does not specify `PriorityClassName` will use the PriorityClass of the job it belongs to.
18+
19+
## Example
20+
```yaml
21+
apiVersion: scheduling.k8s.io/v1
22+
kind: PriorityClass
23+
metadata:
24+
name: job-priority
25+
value: 1
26+
preemptionPolicy: Never
27+
---
28+
apiVersion: scheduling.k8s.io/v1
29+
kind: PriorityClass
30+
metadata:
31+
name: task-priority
32+
value: 10
33+
---
34+
apiVersion: batch.volcano.sh/v1alpha1
35+
kind: Job
36+
metadata:
37+
name: job
38+
spec:
39+
schedulerName: volcano
40+
priorityClassName: job-priority
41+
minAvailable: 1
42+
tasks:
43+
- replicas: 1
44+
name: preempt-task
45+
template:
46+
spec:
47+
priorityClassName: task-priority # The priorityclass is specified individually for this task
48+
containers:
49+
- image: alpine
50+
command: ["/bin/sh", "-c", "sleep 1000"]
51+
name: preempt
52+
resources:
53+
requests:
54+
cpu: 1
55+
- replicas: 1
56+
name: non-preempt-task # This task does not specify PriorityClassName, so it will use the "job-priority" priorityclass specified by job
57+
template:
58+
spec:
59+
containers:
60+
- image: alpine
61+
command: ["/bin/sh", "-c", "sleep 1000"]
62+
name: non-preempt
63+
resources:
64+
requests:
65+
cpu: 1
66+
```

0 commit comments

Comments
 (0)