ethereum-optimism / ethereum-optimism/op-analytics

Owner/Expert Metadata for Tables

Open
#952 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Jupyter Notebook
Stars
155
Forks
92
PR merge metrics
No merged PRs in 30d

Description

# Owner/Expert Metadata for Tables/Models

## Description / Need
We need a simple way to add owner/expert metadata to each table to improve discoverability and make it clear who to contact for specific data questions.

### Proposed Solution
1. **CLI Tool**: Build a CLI tool to update table metadata with owner/expert tags.
2. **Metadata Storage**: Use a YAML file in the repo as the source of truth for all table metadata
3. **Automation**: Leverage GitHub Actions (GHA) to sync metadata updates from the YAML file to a BigQuery table
4. **Visibility**: Start with the CLI and YAML setup, expanding visibility options as the number of tables grows.

### Notes on Metadata
- **BQ-Specific**: Use labels, tags, or descriptions in BQ for tables that support metadata.
- **Centralized Approach**: A centralized YAML-based solution that lives in the repository itself will also update platforms like BQ while covering non-BQ assets.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.