fix README.md clearly #2427

waiterQ · 2022-08-11T07:37:50Z

update jobflow README congruously.

hwdef · 2022-08-11T07:48:50Z

Why make these changes? Have some instructions?

william-wang · 2022-08-11T08:05:02Z

README.md

@@ -60,6 +56,7 @@ Volcano is an incubating project of the [Cloud Native Computing Foundation](http
 - [Horovod/MPI](https://github.com/volcano-sh/volcano/tree/master/example/integrations/mpi)
 - [paddlepaddle](https://github.com/volcano-sh/volcano/tree/master/example/integrations/paddlepaddle)
 - [cromwell](https://github.com/broadinstitute/cromwell/blob/develop/docs/backends/Volcano.md)
+- [jobflow](https://github.com/BoCloud/JobFlow)


Do not need this line here. please lease it as it is.

william-wang · 2022-08-11T08:06:12Z

docs/design/jobflow/README.md

 ## Introduction

 In order to solve the problem of inter-job dependencies. We need many VCJobs to cooperate each other and orchestrate them manually or by another Job Orchestration Platform to get the job done finally.We present an new way of orchestrating VCJobs called JobFlow. We proposed two concepts to running multiple batch jobs automatically named JobTemplate and JobFlow so end users can easily declare their jobs and run them using complex controlling primitives, for example, sequential or parallel executing, if-then-else statement, switch-case statement, loop executing and so on.

-JobFlow helps migrating AI, BigData, HPC workloads to the cloud-native world. Though there are already some workload flow engines, they are not designed for batch job workloads. Those jobs typically have a complex running dependencies and take long time to run, for example days or weeks. JobFlow helps the end users to declare their jobs as an jobTemplate and then reuse them accordingly. Also, JobFlow orchestrating those jobs using complex controlling primitives and launch those jobs automatically. This can significantly reduce the time consumption of an complex job and improve resource utilization. Finally, JobFlow is not an generally purposed workflow engine, it knows the details of VCJobs. End user can have a better understanding of their jobs, for example, job's running state, beginning and ending timestamps, the next jobs to run, pod-failure-ratio and so on.
+[JobFlow](https://github.com/BoCloud/JobFlow) helps migrating AI, BigData, HPC workloads to the cloud-native world. Though there are already some workload flow engines, they are not designed for batch job workloads. Those jobs typically have a complex running dependencies and take long time to run, for example days or weeks. JobFlow helps the end users to declare their jobs as an jobTemplate and then reuse them accordingly. Also, JobFlow orchestrating those jobs using complex controlling primitives and launch those jobs automatically. This can significantly reduce the time consumption of an complex job and improve resource utilization. Finally, JobFlow is not an generally purposed workflow engine, it knows the details of VCJobs. End user can have a better understanding of their jobs, for example, job's running state, beginning and ending timestamps, the next jobs to run, pod-failure-ratio and so on.


JobFlow is already a part of Volcano. Do not need to show another link here.

Signed-off-by: shaoqiu <[email protected]>

waiterQ · 2022-08-11T08:55:34Z

Why make these changes? Have some instructions?

from website/issue/268, i think README should more congruously, jobflow example need more friendly to users

hwdef · 2022-08-11T08:57:10Z

example/jobflow/README.md

+```bash
+# get volcano and jobflow source code from github
+git clone http://github.com/volcano-sh/volcano.git
+git clone https://github.com/BoCloud/JobFlow.git


jobflow has been donated to the volcano community to become part of the volcano project. The relevant PR is under review.
#2383
I don't think it's the right time to change this document at the moment, and wait until the jobflow code is fully integrated before optimizing the documentation.

/hold

so..., no need for example/jobflow/README.md? what about README.md, if no-need change, i will close this pr

This pr can stay open.I think it needs some modification, after that we can merge this pr, and after jobflow is merged, it may need to be modified again.

@hwdef Good suggestion:). We can provide this example doc for our users and update it right after #2383 get merged.

hwdef · 2022-08-11T09:21:13Z

README.md

@@ -30,8 +30,6 @@ are looking forward to your participation.
 **NOTE**: the scheduler is built based on [kube-batch](https://github.com/kubernetes-sigs/kube-batch);
 refer to [#241](https://github.com/volcano-sh/volcano/issues/241) and [#288](https://github.com/volcano-sh/volcano/pull/288) for more detail.

-[JobFlow](./docs/design/jobflow/jobflow.md) is a workflow engine based on volcano Job. It proposes two concepts to automate running multiple batch jobs, named JobTemplate and JobFlow, so end users can easily declare their jobs and run them using complex control primitives such as sequential or parallel execution, if-then -else statement, switch-case statement, loop execution, etc.


It is not recommended to delete all introductions related to jobflow in the readme. You can keep the brief introduction and direct it to the design doc you write.

got it, after #2383, i will modify this pr to get to suitable

hwdef · 2022-08-11T09:21:25Z

/hold cancel

william-wang

/lgtm

volcano-sh-bot · 2022-08-12T01:42:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: william-wang

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [william-wang]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

volcano-sh-bot added the retest-not-required-docs-only label Aug 11, 2022

volcano-sh-bot requested review from hwdef and hzxuzhonghu August 11, 2022 07:37

volcano-sh-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 11, 2022

waiterQ force-pushed the website-issue-268 branch from 24088eb to d9fc289 Compare August 11, 2022 07:39

william-wang reviewed Aug 11, 2022

View reviewed changes

waiterQ force-pushed the website-issue-268 branch from d9fc289 to 9b4531d Compare August 11, 2022 08:26

volcano-sh-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 11, 2022

waiterQ force-pushed the website-issue-268 branch from 9b4531d to 3cd811f Compare August 11, 2022 08:40

volcano-sh-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 11, 2022

waiterQ force-pushed the website-issue-268 branch 2 times, most recently from 1bc429d to 5f9fccf Compare August 11, 2022 08:45

fix README.md comments to make clearly, add example/jobflow/README.md;

6bafe8b

Signed-off-by: shaoqiu <[email protected]>

waiterQ force-pushed the website-issue-268 branch from 5f9fccf to 6bafe8b Compare August 11, 2022 08:47

hwdef reviewed Aug 11, 2022

View reviewed changes

volcano-sh-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 11, 2022

hwdef reviewed Aug 11, 2022

View reviewed changes

volcano-sh-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 11, 2022

william-wang approved these changes Aug 12, 2022

View reviewed changes

volcano-sh-bot assigned william-wang Aug 12, 2022

volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 12, 2022

volcano-sh-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 12, 2022

volcano-sh-bot merged commit 70d29cd into volcano-sh:master Aug 12, 2022

waiterQ deleted the website-issue-268 branch September 30, 2022 06:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix README.md clearly #2427

fix README.md clearly #2427

waiterQ commented Aug 11, 2022

hwdef commented Aug 11, 2022

william-wang Aug 11, 2022

waiterQ Aug 11, 2022

william-wang Aug 11, 2022

waiterQ Aug 11, 2022

waiterQ commented Aug 11, 2022

hwdef Aug 11, 2022

waiterQ Aug 11, 2022

hwdef Aug 11, 2022

william-wang Aug 11, 2022

waiterQ Aug 11, 2022

hwdef Aug 11, 2022

waiterQ Aug 11, 2022

hwdef commented Aug 11, 2022

william-wang left a comment

volcano-sh-bot commented Aug 12, 2022

fix README.md clearly #2427

fix README.md clearly #2427

Conversation

waiterQ commented Aug 11, 2022

hwdef commented Aug 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

waiterQ commented Aug 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hwdef commented Aug 11, 2022

william-wang left a comment

Choose a reason for hiding this comment

volcano-sh-bot commented Aug 12, 2022