Improve documenation and expand guides

[sorentwo]

Replace much of README with Overview and expanded guides.

Introduction

• Installation
• Getting Started / Up and Running (Possibly LiveBook?)
• Ready for Production
  • Logging
  • Pruning
  • Rescuing (Lifeline)
  • Error Handling
  • Instrumentation
• Scaling

Cheatsheets

• Enqueueing / Scheduling

Learning

• Philosophy/Terminology
• Queues
• Workers
• Inserting Jobs
  • Scheduling
  • Prioritizing
• Unique Jobs
• Cron/Periodic Jobs
• Pruning Jobs
• Rescuing Jobs
• Database Isolation
• Umbrella Apps
• Dynamic Repos

[andygimma]

@sorentwo Do you want a hand with this? I’d love to help make Livebook docs a reality for Oban.

[sorentwo]

Help is welcome!

[andygimma]

Sounds good! How would you like for me to start? I could set up a livebook and create a draft for the "Getting Started" section.

If you have something else in mind let me know.

[sorentwo]

I could set up a livebook and create a draft for the "Getting Started" section.

That sounds perfect 👍

[andygimma]

Ok! I'll plan on starting mid-week. Hopefully I'll have the first draft by the weekend.

[andygimma]

@sorentwo Do you plan on using a hosting service or running Livebook on a server? I'm working on the Getting Started section on fly.io, but the free version runs out of memory quickly.

[andygimma]

Livebook offers installation to fly.io and huggingface.co.

[sorentwo]

Do you plan on using a hosting service or running Livebook on a server?

Personally, no, but I'm sure others would like to.

I'm working on the Getting Started section on fly.io, but the free version runs out of memory quickly.

Which part is running out of memory? The Elixir server or the Postgres instance? The Oban Web demo runs on two shared-1x-cpu instances with 256MB of RAM, so I'd be surprised that a getting-started guide is running out of memory.

[andygimma]

Fly.io's free tier is running out of memory. I had to pause to find out where to host the docs and whether or not a paid plan was needed.

[sorentwo]

Ok. So that's without actually running anything other than Livebook and a Mix.install. Well, people will still be able to run it locally at least.

[andygimma]

Ok, I'll focus on setting it up locally.

[andygimma]

Sorry for the delay, things got a little hectic on my end.

So I’ve copied the introduction doc into a Livebook doc, as a way to begin the conversation.

I wonder if Livebook adds any extra value to the existing documentation that you already have. Maybe Livebook would be more useful for particularly difficult use cases. Or maybe you want to implement all documentation into Livebook, so it all lives in one place. Let me know how you’d like to move forward.

As for availability, I will be around every other Sunday through September, and then I can devote more time to this. I think we could use these next few weeks as a way to experiment and nail down the Livebook implementation details.

Below is a screenshot of the Intro page.

[sorentwo]

I imagined something a bit more demonstrative for the "Getting Started" Livebook. Rather than reimplementing the setup guides, it would install and configure Oban and then demonstrate practical usage like writing worker modules, enqueueing jobs, etc.

[Hajto]

Would you mind me giving you some help on this?

[sorentwo]

Would you mind me giving you some help on this?

@Hajto Not at all, help is welcome!