metabase / metabase/metabase

Automate documentation of driver features

Open
#52,053 0 comments 0 reactions 0 assignees View on GitHub
.Team/QueryingPlatform Database/ Type:New Feature
Dominant language
Clojure
Stars
49.3k
Forks
6.8k
Avg merge
1d 13h
Merged PRs (30d)
653

Description

**Is your feature request related to a problem? Please describe.**
We got two documents with driver feature descriptions
- [db tierlist
](https://www.notion.so/metabase/Database-Tiers-for-Feature-Development-fabba4d2bbfb4c729029f5e77d585f61)
- [public] [db features for 3rd-party developers](https://www.notion.so/metabase/Driver-feature-flags-2018c687047343b48f545e839d9948b3)

Given the pace we are adding and changing features, we won't be able to keep them up-to-date manually.

**Describe the solution you'd like**
An automation to update these docs or at least notify the Driver team when they need to be updated.

**Describe alternatives you've considered**
Continue the manula updates

**How important is this feature to you?**
Important to help 3rd-party developers and also communicate database support levels internally

Contributor guide

Open the contributing guide

Research direction

Review the linked database tier and driver-feature documents, then inspect how driver features are represented in the Metabase repository. Define whether the result should update the documents automatically or notify the Driver team, and establish how feature changes will be detected and verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.