-
Notifications
You must be signed in to change notification settings - Fork 125
docs: fix run-together sentences and punctuation spacing #550
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||
|
|
||||||
| ``` | ||||||
| apiVersion: v1 | ||||||
|
|
@@ -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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
|
||||||
|
|
||||||
| ``` | ||||||
| apiVersion: v1 | ||||||
|
|
@@ -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` | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
|
||||||
|
|
||||||
| ``` | ||||||
| git clone https://github.com/volcano-sh/volcano.git | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
|
||||||
|
|
||||||
| #### Scenario | ||||||
|
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title : "Predicates" | ||
| title: "Predicates" | ||
| --- | ||
| ## Overview | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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 | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
|
||||||
| such as [MPI](https://www.open-mpi.org/). It often works with `SVC` plugin. | ||||||
|
|
||||||
| ## Key Points | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In Kubernetes terminology, 'deploys' is usually referred to as 'Deployments'. Updating this makes the documentation more precise.