Updates workflows docs to use the new workflows client #780
Conversation
This file contains hidden or 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
Signed-off-by: Elena Kolevska <elena@kolevska.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release-1.15 #780 +/- ##
===============================================
Coverage ? 86.29%
===============================================
Files ? 89
Lines ? 5029
Branches ? 0
===============================================
Hits ? 4340
Misses ? 689
Partials ? 0 ☔ View full report in Codecov by Sentry. |
elena-kolevska
force-pushed
the
wf-docs
branch
from
fbeeb5f to
28a322b
Compare
msfussell
reviewed
Feb 18, 2025
Member
msfussell
left a comment
msfussell
left a comment
There was a problem hiding this comment.
Main feedback here is that I would move Workflow section to near the top, just after Service Invocation. It is buried at the bottom and it the most important API.
Signed-off-by: Elena Kolevska <elena@kolevska.com>
msfussell
reviewed
Feb 19, 2025
Member
There was a problem hiding this comment.
Reviewing this again, I would take the lead from .NET SDK layout. https://v1-15.docs.dapr.io/developing-applications/sdks/dotnet/
Remove the workflow from the client page and I would put the code for workflow in your PR as an example on the Dapr Workflow overview page here https://v1-15.docs.dapr.io/developing-applications/sdks/python/python-sdk-extensions/python-workflow-ext/
Keep this page as a more detailed description https://v1-15.docs.dapr.io/developing-applications/sdks/python/python-sdk-extensions/python-workflow-ext/python-workflow/
That way all the workflow is in one place
Signed-off-by: Elena Kolevska <elena@kolevska.com>
Signed-off-by: Elena Kolevska <elena@kolevska.com>
Contributor
Author
|
Thanks @msfussell, I updated the PR. |
elena-kolevska
added a commit
to elena-kolevska/python-sdk
that referenced
this pull request
Mar 6, 2025
* Updates docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * More workflows docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <elena@kolevska.com> * Small fixes Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com>
elena-kolevska
added a commit
to elena-kolevska/python-sdk
that referenced
this pull request
Mar 6, 2025
* Updates docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * More workflows docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <elena@kolevska.com> * Small fixes Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com>
elena-kolevska
added a commit
to elena-kolevska/python-sdk
that referenced
this pull request
Mar 6, 2025
* Updates docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * More workflows docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <elena@kolevska.com> * Small fixes Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com>
elena-kolevska
added a commit
that referenced
this pull request
Mar 11, 2025
* Catch error in sdk when workflow instance not found (#771) * Catch error in sdk when workflow instance not found Signed-off-by: Elena Kolevska <elena@kolevska.com> * fixes demo workflow example test Signed-off-by: Elena Kolevska <elena@kolevska.com> * Only return None for the correct error Signed-off-by: Elena Kolevska <elena@kolevska.com> * Adds test Signed-off-by: Elena Kolevska <elena@kolevska.com> * Linter Signed-off-by: Elena Kolevska <elena@kolevska.com> * Extends test Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com> * Fix get_worfklow_state docstring to match fetch_payloads default (#772) Signed-off-by: Adam Stewart <adam.stewart73@gmail.com> Co-authored-by: Elena Kolevska <elena-kolevska@users.noreply.github.com> Signed-off-by: Elena Kolevska <elena@kolevska.com> * Remove test sleep (#778) Signed-off-by: Elena Kolevska <elena@kolevska.com> * Restores sleeps in test, as it was decided not to invest making synchronous the APIs that are getting deleted next version (#781) Signed-off-by: Elena Kolevska <elena@kolevska.com> * Updates workflows docs to use the new workflows client (#780) * Updates docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * More workflows docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <elena@kolevska.com> * Small fixes Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com> * Workflow fixes and improvements (#784) * Converts demo_workflow example to DaprWorkflowClient and removes default timeout of 60seconds on `wait_for_workflow_start` and `wait_for_workflow_completion` Signed-off-by: Elena Kolevska <elena@kolevska.com> * Bumps durable task library. Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com> # Conflicts: # ext/dapr-ext-workflow/setup.cfg * Retry streaming subscription on status UNKNOWN as well (#783) Signed-off-by: Elena Kolevska <elena@kolevska.com> * Adds examples and docs for cloud events messages (#785) Signed-off-by: Elena Kolevska <elena@kolevska.com> * Conversation API support (#787) * Conversation API support (sync) Signed-off-by: Elena Kolevska <elena@kolevska.com> * async conversation api support Signed-off-by: Elena Kolevska <elena@kolevska.com> * Adds docs Signed-off-by: Elena Kolevska <elena@kolevska.com> * Ignore validation of x.com link that needs authentication Signed-off-by: Elena Kolevska <elena@kolevska.com> * Registers e2e test. Clean up. Signed-off-by: Elena Kolevska <elena@kolevska.com> * Apply suggestions from code review Co-authored-by: Marc Duiker <marcduiker@users.noreply.github.com> Signed-off-by: Elena Kolevska <elena-kolevska@users.noreply.github.com> * Linter Signed-off-by: Elena Kolevska <elena@kolevska.com> * Updates protos and renames parameter Signed-off-by: Elena Kolevska <elena@kolevska.com> * Improves error handling Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com> Signed-off-by: Elena Kolevska <elena-kolevska@users.noreply.github.com> Co-authored-by: Marc Duiker <marcduiker@users.noreply.github.com> Signed-off-by: Elena Kolevska <elena@kolevska.com> * Updates dev version to 1.15.0 Signed-off-by: Elena Kolevska <elena@kolevska.com> --------- Signed-off-by: Elena Kolevska <elena@kolevska.com> Signed-off-by: Adam Stewart <adam.stewart73@gmail.com> Signed-off-by: Elena Kolevska <elena-kolevska@users.noreply.github.com> Co-authored-by: Adam Stewart <ajstewart@users.noreply.github.com> Co-authored-by: Marc Duiker <marcduiker@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Issue reference
dapr/docs#4410