Skip to content
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

docs: Missing go examples in user-guide #601

Open
akshat2602 opened this issue Jun 15, 2024 · 0 comments
Open

docs: Missing go examples in user-guide #601

akshat2602 opened this issue Jun 15, 2024 · 0 comments

Comments

@akshat2602
Copy link
Contributor

akshat2602 commented Jun 15, 2024

Following documentations have missing examples for golang SDK:

  1. Quickstart
    1) Installation page doesn't have SDK installation steps
    2) Running your first step doesn't have SDK steps
  2. Understanding steps in Hatchet
    1) Workflow definition
    2) Workflow input
  3. Workflows
    1) Workflow definition
    2) Accessing workflow state within a step
  4. Concurrency Strategies
    1) Control on workflow in overview
    2) Control on workers in overview
    3) Cancel
    4) Round robin
  5. Retries
    1) Simple step-level retry
    2) Manual retry
  6. Timeouts
    1) Refreshing timeouts
  7. Error and logging
    1) Automatic Error Handling for Uncaught Errors
    2) Logging to Hatchet with context.log()
  8. Streaming
    1) Listeners
    2) Streaming from a step context
    3) Streaming files
    4) Consuming streams on frontend
  9. Triggering runs
    1) Configuring event triggers in Event Trigger
    2) Event payloads in Event Trigger
    3) Configuring cron triggers in cron scheduling
    4) Configuring schedule triggers in schedule triggers
    5) Delaying events using child workflows in schedule triggers
  10. Cancellation
    1) Checking for cancellation
    2) Aborting network requests
  11. Child workflows
    1) Looping workflows
    2) Scatter/gather workflows
    3) Error handling

Other language SDKs also have missing examples in the user-guide, those are being tracked in a different issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant