Versioning docs touch-up #405
Merged
+110
−57
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
antlai-temporal
approved these changes
May 16, 2024
| @@ -68,6 +68,14 @@ message TaskQueueVersionSelection { | |||
| message TaskQueueVersionInfo { | |||
| // Task Queue info per Task Type. Key is the numerical value of the temporal.api.enums.v1.TaskQueueType enum. | |||
| map<int32, TaskQueueTypeInfo> types_info = 1; | |||
|
|
|||
| // Task Reachability is eventually consistent; there may be a delay until it converges to the most | |||
| // accurate value but it is designed in a way to take the more conservative side until it converges. | |||
There was a problem hiding this comment.
Can you clarify what "conservative" means?
| // Task Reachability is eventually consistent; there may be a delay until it converges to the most | ||
| // accurate value but it is designed in a way to take the more conservative side until it converges. | ||
| // Note: future activities who inherit their workflow's Build ID but not its Task Queue will not be | ||
| // accounted for reachability as server cannot not know if they'll happen as they do not use |
Comment on lines
158
to
159
| // (by running in the same Task Queue or explicitly setting the | ||
| // `inherit_build_id` flag.) |
There was a problem hiding this comment.
"by running in the same Task Queue"
Is that always the case, if they use the same task queue they always inherit?
There was a problem hiding this comment.
no, I changed the test to not get involved in that too much. from the API perspective we only look at the passed boolean. It's SDK's responsibility to send the right default value based on the task queue used.
Comment on lines
221
to
222
| // Target Build ID must be compatible with the Source Build ID; that is it | ||
| // must be able to process event histories generation by Source Build ID. |
There was a problem hiding this comment.
I don't understand this comment. Can you clarify compatible (patch api..)?
Comment on lines
578
to
579
| // Redirect rules should only be used when it's desired to move open workflows from one Build ID to | ||
| // another compatible Build ID. You are responsible to make sure the target Build ID of a redirect |
There was a problem hiding this comment.
Make clear they affect all running workflows not only new ones...
dnr
reviewed
May 20, 2024
Co-authored-by: David Reiss <david@temporal.io>
Co-authored-by: David Reiss <david@temporal.io>
Co-authored-by: David Reiss <david@temporal.io>
Co-authored-by: David Reiss <david@temporal.io>
Co-authored-by: David Reiss <david@temporal.io>
Co-authored-by: David Reiss <david@temporal.io>
dnr
approved these changes
May 21, 2024
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 changed?
Some improvements to versioning docs.
Why?
Breaking changes
Server PR