[go: up one dir, main page]

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

Improve documenation and expand guides #850

Open
20 of 23 tasks
sorentwo opened this issue Feb 17, 2023 · 15 comments
Open
20 of 23 tasks

Improve documenation and expand guides #850

sorentwo opened this issue Feb 17, 2023 · 15 comments
Labels
area:oss Related to Oban OSS kind:documentation Adds or improves documentation

Comments

@sorentwo
Copy link
Member
sorentwo commented Feb 17, 2023

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
@sorentwo sorentwo added kind:documentation Adds or improves documentation area:oss Related to Oban OSS labels Feb 17, 2023
@andygimma
Copy link
andygimma commented May 27, 2023

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

@sorentwo
Copy link
Member Author

Help is welcome!

@andygimma
Copy link

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
Copy link
Member Author
sorentwo commented Jun 3, 2023

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

That sounds perfect 👍

@andygimma
Copy link

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

@andygimma
Copy link

@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
Copy link

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

@sorentwo
Copy link
Member Author

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
Copy link

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.

Screenshot 2023-06-13 at 5 08 53 PM Screenshot 2023-06-13 at 5 09 07 PM

@sorentwo
Copy link
Member Author

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
Copy link

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

@andygimma
Copy link

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.

livebook-1

@sorentwo
Copy link
Member Author
sorentwo commented Aug 8, 2023

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
Copy link
Hajto commented Oct 15, 2023

Would you mind me giving you some help on this?

@sorentwo
Copy link
Member Author

Would you mind me giving you some help on this?

@Hajto Not at all, help is welcome!

sorentwo added a commit that referenced this issue Nov 3, 2023
The new guide covers logging, instrumentation, pruning, and rescuing.

Addresses part of #850
sorentwo added a commit that referenced this issue Nov 3, 2023
The new guide covers logging, instrumentation, pruning, and rescuing.

Addresses part of #850
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:oss Related to Oban OSS kind:documentation Adds or improves documentation
Projects
None yet
Development

No branches or pull requests

3 participants