docs: fix run-together sentences and punctuation spacing#550
Conversation
volcano-sh-bot
added
the
kind/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
volcano-sh-bot
added
the
size/S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request corrects spacing and formatting issues across several documentation files. The reviewer provided helpful suggestions to further improve the documentation's clarity, grammar, and terminology, such as using standard Kubernetes terms like 'Deployments', simplifying redundant descriptions, and correcting phrasing to 'passwordless login' and 'Volcano Job'.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| ##### 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. |
There was a problem hiding this comment.
In Kubernetes terminology, 'deploys' is usually referred to as 'Deployments'. Updating this makes the documentation more precise.
| 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. |
| ``` | ||
|
|
||
| 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. |
There was a problem hiding this comment.
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.
| 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. |
| ### 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. |
There was a problem hiding this comment.
The phrase 'This way is only available' is a bit colloquial. Using 'This method is currently only supported on' is more professional and clear.
| 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. |
| #### 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. |
There was a problem hiding this comment.
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.
| 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. |
| ## 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-nodes cluster and vcjob called job-1: |
There was a problem hiding this comment.
Improve the grammar and terminology by changing 'four-nodes cluster' to 'four-node cluster' and 'vcjob' to 'VCJob' (or 'Volcano Job') for consistency and correctness.
| 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 a VCJob called job-1: |
|
|
||
| ## 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 |
There was a problem hiding this comment.
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.
| **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 |
Signed-off-by: aeron-gh <[email protected]>
56e7345 to
37f9925
Compare
|
This PR is intentionally scoped to spacing and punctuation fixes (run-together sentences), so I've kept the diff to that. I did fold in the The wording and terminology suggestions (Deployments, passwordless login, capitalizing |
|
@yashisrani sir If you'd like, I can also incorporate Gemini's wording/terminology suggestions into this PR. Otherwise, I'm happy to keep this one focused on the spacing changes and handle those separately whatever you prefer. |
2 participants
/kind documentation
Fixes run-together sentences (missing space after a period) and a few stray spaces before punctuation across the docs. These currently render as joined words on the site, e.g. "constraint.If" and "Volcano.The". Text-only, no content changes.
I used an AI assistant to scan the docs and surface these spacing issues, and reviewed every change by hand.
Fixes #549