Add documentation for new activity commands - pause/unpause/reset/update #3358
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
|
|
ychebotarev
force-pushed
the
y_activity_docs
branch
from
7223c42 to
d7b5c50
Compare
jsundai
reviewed
Feb 21, 2025
| Pausing the activity can be undone by using the `temporal activity unpause` command. | ||
|
|
||
| Pausing an activity means: | ||
| * If the activity is currently waiting for a retry or is running and subsequently fails, it will not be rescheduled until it is unpaused. |
There was a problem hiding this comment.
Please capitalize Activity throughout this. We generally capitalize any words that are referenced in the glossary as key terms.
jsundai
reviewed
Feb 21, 2025
| * If the activity is already paused, calling this method will have no effect. | ||
| * If the activity is running and finishes successfully, the activity will be completed. | ||
| * If the activity is running and finishes with failure: | ||
| * if there is no retry left - the activity will be completed. |
There was a problem hiding this comment.
Suggested change
| * if there is no retry left - the activity will be completed. | |
| * If there is no retry left then the Activity will be completed. |
jsundai
reviewed
Feb 21, 2025
| The `temporal activity reset` command restarts a running [Activity Execution](/activities#activity-execution) specified by its ID or type. | ||
| If there are multiple pending activities of the provided type - all of them will be reset. | ||
| Resetting an activity means: | ||
| * number of attempts will be reset to 0; |
There was a problem hiding this comment.
Suggested change
| * number of attempts will be reset to 0; | |
| * The number of attempts will be reset to 0; |
|
Did a quick glance, will do a more in-depth review. Great work so far! |
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?
This PR adds documentation to the following new activity CLI commands:
Notes to reviewers
EDU-3991