-
Notifications
You must be signed in to change notification settings - Fork 134
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
Updates workflows docs to use the new workflows client #780
Conversation
Signed-off-by: Elena Kolevska <[email protected]>
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. |
fbeeb5f
to
28a322b
Compare
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.
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 <[email protected]>
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.
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 <[email protected]>
Signed-off-by: Elena Kolevska <[email protected]>
Thanks @msfussell, I updated the PR. |
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.
LGTM
* Updates docs Signed-off-by: Elena Kolevska <[email protected]> * More workflows docs Signed-off-by: Elena Kolevska <[email protected]> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <[email protected]> * Small fixes Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]>
* Updates docs Signed-off-by: Elena Kolevska <[email protected]> * More workflows docs Signed-off-by: Elena Kolevska <[email protected]> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <[email protected]> * Small fixes Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]>
* Updates docs Signed-off-by: Elena Kolevska <[email protected]> * More workflows docs Signed-off-by: Elena Kolevska <[email protected]> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <[email protected]> * Small fixes Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]>
* Catch error in sdk when workflow instance not found (#771) * Catch error in sdk when workflow instance not found Signed-off-by: Elena Kolevska <[email protected]> * fixes demo workflow example test Signed-off-by: Elena Kolevska <[email protected]> * Only return None for the correct error Signed-off-by: Elena Kolevska <[email protected]> * Adds test Signed-off-by: Elena Kolevska <[email protected]> * Linter Signed-off-by: Elena Kolevska <[email protected]> * Extends test Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> * Fix get_worfklow_state docstring to match fetch_payloads default (#772) Signed-off-by: Adam Stewart <[email protected]> Co-authored-by: Elena Kolevska <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Remove test sleep (#778) Signed-off-by: Elena Kolevska <[email protected]> * 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 <[email protected]> * Updates workflows docs to use the new workflows client (#780) * Updates docs Signed-off-by: Elena Kolevska <[email protected]> * More workflows docs Signed-off-by: Elena Kolevska <[email protected]> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <[email protected]> * Small fixes Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> * 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 <[email protected]> * Bumps durable task library. Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> # Conflicts: # ext/dapr-ext-workflow/setup.cfg * Retry streaming subscription on status UNKNOWN as well (#783) Signed-off-by: Elena Kolevska <[email protected]> * Adds examples and docs for cloud events messages (#785) Signed-off-by: Elena Kolevska <[email protected]> * Conversation API support (#787) * Conversation API support (sync) Signed-off-by: Elena Kolevska <[email protected]> * async conversation api support Signed-off-by: Elena Kolevska <[email protected]> * Adds docs Signed-off-by: Elena Kolevska <[email protected]> * Ignore validation of x.com link that needs authentication Signed-off-by: Elena Kolevska <[email protected]> * Registers e2e test. Clean up. Signed-off-by: Elena Kolevska <[email protected]> * Apply suggestions from code review Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Linter Signed-off-by: Elena Kolevska <[email protected]> * Updates protos and renames parameter Signed-off-by: Elena Kolevska <[email protected]> * Improves error handling Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Updates dev version to 1.15.0 Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> Signed-off-by: Adam Stewart <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> Co-authored-by: Adam Stewart <[email protected]> Co-authored-by: Marc Duiker <[email protected]>
Issue reference
dapr/docs#4410