You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by GitBox <gi...@apache.org> on 2022/01/10 20:15:21 UTC
[GitHub] [helix] qqu0127 opened a new pull request #1932: Improve helix tutorial and code formatting (#1931)
qqu0127 opened a new pull request #1932:
URL: https://github.com/apache/helix/pull/1932
### Issues
- [x] My PR addresses the following Helix issues and references them in the PR description:
Fixed issue #1931 , improve Helix tutorial and minor changes to code formatting and comments.
### Description
- [x] Here are some details about my PR, including screenshots of any UI changes:
Improve Helix tutorial and minor changes to code formatting and comments.
### Tests
- [x] The following tests are written for this issue:
mvn test
- The following is the result of the "mvn test" command on the appropriate module:
All test passed
### Commits
- My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Code Quality
- My diff has been formatted using helix-style.xml
(helix-style-intellij.xml if IntelliJ IDE is used)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] narendly commented on a change in pull request #1932: Improve helix tutorial and code formatting (#1931)
Posted by GitBox <gi...@apache.org>.
narendly commented on a change in pull request #1932:
URL: https://github.com/apache/helix/pull/1932#discussion_r781692701
##########
File path: website/0.9.8/src/site/markdown/tutorial_task_framework.md
##########
@@ -23,15 +23,15 @@ under the License.
## [Helix Tutorial](./Tutorial.html): Task Framework
-Task framework, in Helix, provides executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
+Task framework, in Helix, provides an executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
Task framework not only can abstract three layers task logics but also helps doing task assignment and rebalancing. User can create a workflow (or a job queue) at first beginning. Then jobs can be added into workflow. Those jobs contain the executable tasks implemented by user. Once workflow is completed, Helix will schedule the works based on the condition user provided.
### Key Concepts
-* Task is the basic unit in Helix task framework. It can represents the a single runnable logics that user prefer to execute for each partition (distributed units).
+* Task is the basic unit in Helix task framework. It represents a single runnable logics that user prefer to execute for each partition (distributed units).
Review comment:
"Task is the smallest unit of work in Helix Task Framework..." might be more intuitive.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] qqu0127 commented on a change in pull request #1932: Improve helix tutorial and code formatting (#1931)
Posted by GitBox <gi...@apache.org>.
qqu0127 commented on a change in pull request #1932:
URL: https://github.com/apache/helix/pull/1932#discussion_r781704233
##########
File path: website/0.9.8/src/site/markdown/tutorial_task_framework.md
##########
@@ -23,15 +23,15 @@ under the License.
## [Helix Tutorial](./Tutorial.html): Task Framework
-Task framework, in Helix, provides executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
+Task framework, in Helix, provides an executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
Review comment:
thanks, fixed in new commit.
##########
File path: website/0.9.8/src/site/markdown/tutorial_task_framework.md
##########
@@ -23,15 +23,15 @@ under the License.
## [Helix Tutorial](./Tutorial.html): Task Framework
-Task framework, in Helix, provides executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
+Task framework, in Helix, provides an executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
Task framework not only can abstract three layers task logics but also helps doing task assignment and rebalancing. User can create a workflow (or a job queue) at first beginning. Then jobs can be added into workflow. Those jobs contain the executable tasks implemented by user. Once workflow is completed, Helix will schedule the works based on the condition user provided.
### Key Concepts
-* Task is the basic unit in Helix task framework. It can represents the a single runnable logics that user prefer to execute for each partition (distributed units).
+* Task is the basic unit in Helix task framework. It represents a single runnable logics that user prefer to execute for each partition (distributed units).
Review comment:
thanks, fixed in new commit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] narendly commented on a change in pull request #1932: Improve helix tutorial and code formatting (#1931)
Posted by GitBox <gi...@apache.org>.
narendly commented on a change in pull request #1932:
URL: https://github.com/apache/helix/pull/1932#discussion_r781692522
##########
File path: website/0.9.8/src/site/markdown/tutorial_task_framework.md
##########
@@ -23,15 +23,15 @@ under the License.
## [Helix Tutorial](./Tutorial.html): Task Framework
-Task framework, in Helix, provides executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
+Task framework, in Helix, provides an executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job.
Review comment:
No particle "an" needed :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] narendly merged pull request #1932: Improve helix tutorial and code formatting (#1931)
Posted by GitBox <gi...@apache.org>.
narendly merged pull request #1932:
URL: https://github.com/apache/helix/pull/1932
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org