Skip to content

Commit

Permalink
Update docs after open sourcing web
Browse files Browse the repository at this point in the history
This removes mentions of Web as a paid package and makes more effort to
highlight Pro. Links to Web in the "ready for production" guide now
point to the official pacakge as well.
  • Loading branch information
sorentwo committed Jan 17, 2025
1 parent 8be2909 commit 62b87db
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 30 deletions.
40 changes: 26 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
## Table of Contents

- [Features](#features)
- [Oban Web+Pro](#oban-webpro)
- [Oban Pro](#oban-pro)
- [Engines](#engines)
- [Requirements](#requirements)
- [Installation](#installation)
Expand All @@ -52,6 +52,8 @@

---

<!-- MDOC -->

## Features

Oban's primary goals are **reliability**, **consistency** and **observability**.
Expand Down Expand Up @@ -122,19 +124,31 @@ without worrying about jobs being lost or orphaned due to crashes.

[tele]: https://github.com/beam-telemetry/telemetry

## Oban Web+Pro
## 🌟 Oban Pro

> [!TIP]
>
> A web dashboard for managing Oban, along with an official set of extensions, plugins, and
> workers that expand what Oban is capable of are available as licensed packages:
>
> * [🧭 Oban Web](https://oban.pro#oban-web)
> * [🌟 Oban Pro](https://oban.pro#oban-pro)
>
> Learn more at [oban.pro][pro]!
An official set of extensions, plugins, and workers that expand what Oban is capable of is
available as a licensed package. It includes features like:

<!-- MDOC -->
* 🖇️ [Workflows][wor]
* 🎨 [Decorators][dec]
* ⛓️ [Chains][cha]
* 🏗️ [Structured Jobs][str]
* 🪝 [Worker Hooks][hoo]
* 🌎 [Global Limits][glo]
* 🔪 [Queue Partitioning][par]
* 🎢 [Dynamic Queues][dyn]

Plus [much more][ove]. Learn more about [Oban Pro](https://oban.pro#oban-pro)

[cha]: https://oban.pro/docs/pro/Oban.Pro.Worker.html#module-chained-jobs
[dec]: https://oban.pro/docs/pro/Oban.Pro.Decorator.html
[dyn]: https://oban.pro/docs/pro/Oban.Pro.Plugins.DynamicQueues.html
[glo]: https://oban.pro/docs/pro/Oban.Pro.Engines.Smart.html#module-global-concurrency
[hoo]: https://oban.pro/docs/pro/Oban.Pro.Worker.html#module-worker-hooks
[par]: https://oban.pro/docs/pro/Oban.Pro.Engines.Smart.html#module-queue-partitioning
[ove]: https://oban.pro/docs/pro/overview.html
[str]: https://oban.pro/docs/pro/Oban.Pro.Worker.html#module-structured-jobs
[wor]: https://oban.pro/docs/pro/Oban.Pro.Workers.Workflow.html

## Engines

Expand Down Expand Up @@ -232,5 +246,3 @@ commands:
* Lint with Credo (`mix credo --strict`)
* Run all tests (`mix test --raise`)
* Run Dialyzer (`mix dialyzer`)

[pro]: https://oban.pro
6 changes: 4 additions & 2 deletions guides/introduction/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,10 +155,12 @@ iex(1)> Oban.config()
#=> %Oban.Config{repo: MyApp.Repo}
```

You're all set! Get started creating jobs and configuring queues in [Usage][use], or head to the
[testing guide][test] to learn how to test with Oban.
You're all set! Add the [Oban Web][web] dashboard for monitoring, get started creating jobs and
configuring queues in [Usage][use], or head to the [testing guide][test] to learn how to test with
Oban.

[use]: Oban.html#Usage
[web]: https://github.com/oban-bg/oban_web
[test]: testing.md
[postgrex]: https://hex.pm/packages/postgrex
[ecto_sqlite3]: https://hex.pm/packages/ecto_sqlite3
Expand Down
6 changes: 3 additions & 3 deletions guides/introduction/ready_for_production.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ job maintenance.
For additional observability and introspection, consider integrating with one of these external
tools built on `Oban.Telemetry`:

* [Oban Web](https://oban.pro)—an official Oban package, it's a view of jobs, queues, and
metrics that you host directly within your application. Powered by Phoenix LiveView and Oban
Metrics, it is extremely lightweight and continuously updated.
* [Oban Web](https://hex.pm/packages/oban_web)—an official Oban package, it's a view of jobs,
queues, and metrics that you host directly within your application. Powered by Phoenix LiveView
and Oban Metrics, it is extremely lightweight and continuously updated.

* [PromEx](https://hex.pm/packages/prom_ex)—Prometheus metrics and Grafana dashboards based on
metrics from job events, producer events, and also from internal polling jobs to monitor queue
Expand Down
11 changes: 0 additions & 11 deletions lib/oban.ex
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,6 @@ defmodule Oban do
@doc_header """
Oban is a robust background job framework which uses PostgreSQL, MySQL, or SQLite3 for
persistence.
> #### Oban Web+Pro {: .tip}
>
> A web dashboard for managing Oban, along with an official set of extensions, plugins, and
> workers that expand what Oban is capable of are available as licensed packages:
>
> * [🧭 Oban Web](https://oban.pro#oban-web)
> * [🌟 Oban Pro](https://oban.pro#oban-pro)
>
> Learn more at [oban.pro](https://oban.pro)!
"""

@doc_footer readme
Expand Down

0 comments on commit 62b87db

Please sign in to comment.