-
Notifications
You must be signed in to change notification settings - Fork 224
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
EDU-1867 #2833
base: main
Are you sure you want to change the base?
EDU-1867 #2833
Conversation
37b1ebd
to
ac87ef2
Compare
…ocumentation into evaluatetemporal-howitworks
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.
I don't want to block too much more as an MVP.
But consider giving it another pass and flexing your creativity here.
This is a great place to counter misconceptions up front such as:
- "The Temporal Service does not execute your code!"
Or provide clarity about where components are used such as:
- "Embed a Temporal Client directly in your HTTP gateway."
- "Your application code can be run on as many machines / servers as needed to handle high throughput".
- etc...
And you could place those statements strategically around the images.
docs/evaluate/how-it-works.mdx
Outdated
Workers execute the actual tasks defined in your Workflows. | ||
The Temporal Service tracks and coordinates these Workers. | ||
|
||
Whenever your application needs to perform a task, like sending a notification or calling an processing a payment, the Temporal Service steps in. |
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.
Whenever your application needs to perform a task, like sending a notification or calling an processing a payment, the Temporal Service steps in. | |
Whenever your application needs to perform a task, like sending a notification or calling an processing a payment, it requests execution of a task to the Temporal Service. |
docs/evaluate/how-it-works.mdx
Outdated
The Temporal Service tracks and coordinates these Workers. | ||
|
||
Whenever your application needs to perform a task, like sending a notification or calling an processing a payment, the Temporal Service steps in. | ||
This process creates a clear, organized list of what needs to be done. |
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.
This process creates a clear, organized list of what needs to be done. | |
The service creates tasks and adds them to a task queue, for Workers to eventually execute. |
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.
I don't think I've explained task queue yet to be able to state it here (i.e - progressive disclosure). Aiming to explain Temporal Service without any Temporal terms that haven't been stated.
docs/evaluate/how-it-works.mdx
Outdated
This process creates a clear, organized list of what needs to be done. | ||
|
||
Workers, which are part of your application and provided by the Temporal SDK, then carry out the tasks and run your code. | ||
The Worker polls the Temporal Service to see if there are tasks available and the Temporal Service matches the Task with the Worker. |
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.
The Worker polls the Temporal Service to see if there are tasks available and the Temporal Service matches the Task with the Worker. | |
The Worker polls the Temporal Service to see if there are tasks available and the Temporal Service matches the task with the Worker. |
docs/evaluate/how-it-works.mdx
Outdated
|
||
Workers, which are part of your application and provided by the Temporal SDK, then carry out the tasks and run your code. | ||
The Worker polls the Temporal Service to see if there are tasks available and the Temporal Service matches the Task with the Worker. | ||
The Worker runs the Workflow function based on the details specified in the Task. |
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.
The Worker runs the Workflow function based on the details specified in the Task. | |
The Worker runs the Workflow function/method based on the details specified in the Task. |
What does this PR do?
Open to suggestions.
Preview
Thanks!
Notes to reviewers
Progressive disclosure.
Note the tone is technical and authoritative (friendly but formal) with hints of bold and impactful.