hatchet-dev / hatchet

A distributed, fault-tolerant task queue

Home Page:https://hatchet.run

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

docs: Missing go examples in user-guide

akshat2602 opened this issue · comments

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.