Documentation to write:

  • dependencies

  • why it exists

  • what problems it solves is it sufficient to say that it allows background routine execution?

  • structure
    • what is recruiter

    • what is a worker

    • what is the cleaner

  • setup
    • installation

    • launching recruiter

    • launching workers

    • launching cleaners

  • examples
    • hello world: single task that must be completed

    • without retry policy (hello world)

    • schedule immediately

    • schedule in the future

    • with simple retry policy

    • retryable exceptions

    • complex retry policies (exponential backoff)

    • optimistic task

  • deep dives
    • how to implement a workable

    • how to implement a retry policy (not detailed, but one can look at the implementation of one of the many existing ones to understand how to do it…)

    • tags

    • recruiter statistics

    • hooks

    • repeatable jobs

    • working-on (priority queues)

    • collections (what archived is for, etc.)

    • how to put a job back in queue

    • execution in tests

    • inject the logger

    • geezer