Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/Concepts/Queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ deserved indicates the expected resource amount for all PodGroups in this queue.

* capability, *optional*

`capability` indicates the upper limit of resources the queue can use. It is a hard constraint.If this field is not set, the queue's capability will be set to realCapability (total cluster resources minus the total guarantee values of other queues).
`capability` indicates the upper limit of resources the queue can use. It is a hard constraint. If this field is not set, the queue's capability will be set to realCapability (total cluster resources minus the total guarantee values of other queues).

* reclaimable, *optional*

Expand Down
6 changes: 3 additions & 3 deletions docs/Ecosystem/FlinkOnVolcano.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ $ tail log/flink-*-taskexecutor-*.out

##### 1. The deployment of the component

Deploying a Flink Cluster requires creating two deploys, a Service, and a ConfigMap. The scheduling strategy is Volcano.The contents of `flink-configuration-configmap.yaml` are shown below.
Deploying a Flink Cluster requires creating two deploys, a Service, and a ConfigMap. The scheduling strategy is Volcano. The contents of `flink-configuration-configmap.yaml` are shown below.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

In Kubernetes terminology, 'deploys' is usually referred to as 'Deployments'. Updating this makes the documentation more precise.

Suggested change
Deploying a Flink Cluster requires creating two deploys, a Service, and a ConfigMap. The scheduling strategy is Volcano. The contents of `flink-configuration-configmap.yaml` are shown below.
Deploying a Flink Cluster requires creating two Deployments, a Service, and a ConfigMap. The scheduling strategy is Volcano. The contents of `flink-configuration-configmap.yaml` are shown below.


```
apiVersion: v1
Expand Down Expand Up @@ -118,7 +118,7 @@ data:
logger.netty.level = OFF
```

Service is used to provide services for the REST and UI ports of the JobManager.The contents of `jobManager-Service.yaml` are as follows.
Service is used to provide services for the REST and UI ports of the JobManager. The contents of `jobManager-Service.yaml` are as follows.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The phrase 'Service is used to provide services' is redundant. We can rephrase it to 'A Service is used to provide access to' for better clarity and flow.

Suggested change
Service is used to provide services for the REST and UI ports of the JobManager. The contents of `jobManager-Service.yaml` are as follows.
A Service is used to provide access to the REST and UI ports of the JobManager. The contents of `jobManager-Service.yaml` are as follows.


```
apiVersion: v1
Expand Down Expand Up @@ -263,4 +263,4 @@ Once the Flink payload is created, you need to publish the service externally。
- If you use Huawei Cloud CCE for testing, go to the "Workloads - Stateless Loads" page of CCE. Select Flink-JobManager and click Access Mode.
- Click "Add Service", select node access, and enter container port bit 8081.
- Click Network Management in CCE, you can see the service we just added, and visit the link for external publication.
- Go to the Dashboard page of Flink and click Submit New Job to submit the task. Here you have the option to submit an officially-provided WordCount sample.The directory is `flink-1.12.2/examples/streaming/WordCount.jar`
- Go to the Dashboard page of Flink and click Submit New Job to submit the task. Here you have the option to submit an officially-provided WordCount sample. The directory is `flink-1.12.2/examples/streaming/WordCount.jar`
2 changes: 1 addition & 1 deletion docs/Ecosystem/PaddlePaddleOnVolcano.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Deploy under the cluster terminal.
kubectl apply -f ctr-volcano.yaml
```

Query if the job is running properly.If the PodGroup cannot meet the scheduling conditions, check that the cluster has sufficient resources available.
Query if the job is running properly. If the PodGroup cannot meet the scheduling conditions, check that the cluster has sufficient resources available.

```
kubectl get podgroup
Expand Down
2 changes: 1 addition & 1 deletion docs/GettingStarted/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can also replace `master` of above url with specific tag/branch (such as `re

### Install from code

If you don't have a Kubernetes cluster, try one-click install from code base.This way is only available for x86_64 temporarily.
If you don't have a Kubernetes cluster, try one-click install from code base. This way is only available for x86_64 temporarily.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The phrase 'This way is only available' is a bit colloquial. Using 'This method is currently only supported on' is more professional and clear.

Suggested change
If you don't have a Kubernetes cluster, try one-click install from code base. This way is only available for x86_64 temporarily.
If you don't have a Kubernetes cluster, try one-click install from code base. This method is currently only supported on x86_64.


```
git clone https://github.com/volcano-sh/volcano.git
Expand Down
2 changes: 1 addition & 1 deletion docs/Scheduler/Actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In a cluster, besides workloads that require explicit resource requests, there a

#### Overview

The preempt action is used for resource preemption between jobs in a queue , or between tasks in a job.The preempt action is a preemption step in the scheduling process, which is used to deal with high-priority scheduling problems. It is used for preemption between jobs in the same queue, or between tasks under the same job.
The preempt action is used for resource preemption between jobs in a queue, or between tasks in a job. The preempt action is a preemption step in the scheduling process, which is used to deal with high-priority scheduling problems. It is used for preemption between jobs in the same queue, or between tasks under the same job.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The description of the preempt action is highly redundant, repeating the same concept three times in different ways. We can simplify and clarify this sentence to make it more professional and readable.

Suggested change
The preempt action is used for resource preemption between jobs in a queue, or between tasks in a job. The preempt action is a preemption step in the scheduling process, which is used to deal with high-priority scheduling problems. It is used for preemption between jobs in the same queue, or between tasks under the same job.
The preempt action is a step in the scheduling process used to handle high-priority scheduling. It enables resource preemption between jobs in the same queue, or between tasks within the same job.


#### Scenario

Expand Down
2 changes: 1 addition & 1 deletion docs/Scheduler/Plugins/predicates.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title : "Predicates"
title: "Predicates"
---
## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/UserGuide/user_guide_how_to_use_extender.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ data:
```

### Verify Extender is working
The user can see in the log something like : `Initialize extender plugin with configuration : {your configuration}`
The user can see in the log something like: `Initialize extender plugin with configuration : {your configuration}`
2 changes: 1 addition & 1 deletion docs/UserGuide/user_guide_how_to_use_nodegroup_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ spec:

## How the Nodegroup Plugin Works

The nodegroup design document provides the most detailed information about the node group. There are some tips to help avoid certain issues.These tips are based on a four-nodes cluster and vcjob called job-1:
The nodegroup design document provides the most detailed information about the node group. There are some tips to help avoid certain issues. These tips are based on a four-node cluster and vcjob called job-1:

| Node | Label |
| ----- | ---------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/UserGuide/user_guide_how_to_use_ssh_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Volcano Job Plugin -- SSH User Guide"


## Background
**SSH Plugin** is designed for the login without password for pods within a volcano job , which is necessary for workloads
**SSH Plugin** is designed for the login without password for pods within a volcano job, which is necessary for workloads

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The phrase 'the login without password' is a bit awkward. Using 'passwordless login' is more idiomatic. Additionally, 'volcano job' should be capitalized as 'Volcano Job' to match the product's naming convention.

Suggested change
**SSH Plugin** is designed for the login without password for pods within a volcano job, which is necessary for workloads
**SSH Plugin** is designed for passwordless login between pods within a Volcano Job, which is necessary for workloads

such as [MPI](https://www.open-mpi.org/). It often works with `SVC` plugin.

## Key Points
Expand Down