-
-
Notifications
You must be signed in to change notification settings - Fork 311
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
Comments
@sorentwo Do you want a hand with this? I’d love to help make Livebook docs a reality for Oban. |
Help is welcome! |
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. |
That sounds perfect 👍 |
Ok! I'll plan on starting mid-week. Hopefully I'll have the first draft by the weekend. |
@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. |
Livebook offers installation to fly.io and huggingface.co. |
Personally, no, but I'm sure others would like to.
Which part is running out of memory? The Elixir server or the Postgres instance? The Oban Web demo runs on two |
Ok. So that's without actually running anything other than Livebook and a |
Ok, I'll focus on setting it up locally. |
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. |
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. |
Would you mind me giving you some help on this? |
@Hajto Not at all, help is welcome! |
The new guide covers logging, instrumentation, pruning, and rescuing. Addresses part of #850
The new guide covers logging, instrumentation, pruning, and rescuing. Addresses part of #850
Replace much of README with Overview and expanded guides.
Introduction
Cheatsheets
Learning
The text was updated successfully, but these errors were encountered: