EDU-1867 #2833
Open
EDU-1867 #2833
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flossypurse
reviewed
May 20, 2024
jsundai
force-pushed
the
evaluatetemporal-howitworks
branch
from
37b1ebd
to
ac87ef2
Compare
…ocumentation into evaluatetemporal-howitworks
flossypurse
reviewed
Jun 12, 2024
There was a problem hiding this comment.
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.
rachfop
reviewed
Jun 13, 2024
MasonEgger
reviewed
Oct 1, 2024
MasonEgger
reviewed
Oct 3, 2024
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.
Suggested change
| 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.
Suggested change
| 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.
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.
Suggested change
| 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.
Suggested change
| 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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.