DEV Community

Cover image for What getting into thirteen database projects' docs actually took
Abdullah Kaya
Abdullah Kaya

Posted on

What getting into thirteen database projects' docs actually took

Thirteen database projects now list LibreDB Studio, our open source browser SQL IDE, in their official documentation: PostgreSQL, Redis, ClickHouse, MariaDB, DuckDB, Trino, YugabyteDB, StarRocks, DragonflyDB, OpenSearch, Apache Cloudberry, Apache Druid and Aiven (PostgreSQL, MySQL).

Each listing went through that project's own review. Here is what that looked like.

How long it took

  • DuckDB merged the same day the pull request was opened, and so did Aiven's second guide. Aiven's first one took under three days.
  • Apache Cloudberry took about five days.
  • OpenSearch took about two weeks, YugabyteDB about two and a half.
  • Apache Druid merged in a week, then waited almost six weeks for its site to be republished, which came with the Druid 38.0.0 release.

Read the contributing guide before the docs page

Every project wants the entry in a different shape: a YAML row, a full guide page, one line in a list. Copying what the last tool did in the same file worked better than anything we wrote from scratch.

Test against the engine first

A docs page is a claim that the tool works with that engine. Before opening a pull request we ran the product against a live instance of it, so the page describes what we measured.

Be specific about compatibility

Our compatibility table lists 28 engines that connect through another engine's driver: 18 work fully, 9 partially, 1 only in the query editor. Being specific made reviews shorter.

Why bother

A docs page is where someone lands after they already chose a database and want to know what to use with it. That is a better first impression than an ad, and it only happens if the maintainers agree.


LibreDB Studio is MIT licensed. You deploy it next to your database and open it in the browser.

docker run -p 3000:3000 ghcr.io/libredb/libredb-studio:latest
Enter fullscreen mode Exit fullscreen mode

Repo: https://github.com/libredb/libredb-studio

Top comments (0)