dbt-labs / dbt-labs/dbt-docs

Allow Group Descriptions to Appear in Generated dbt Docs

Open
#571 0 comments 0 reactions 0 assignees View on GitHub
enhancement triage
Dominant language
JavaScript
Stars
161
Forks
91
PR merge metrics
No merged PRs in 30d

Description

### Describe the feature
Support for rendering group-level descriptions in dbt docs.

Sample:

finance.yml
```
groups:
- name: finance
owner:
# 'name' or 'email' is required; additional properties will no longer be allowed in a future release
email: finance@jaffleshop.com
description: For the finance team
config:
meta: # optional
data_owner: Finance team
```

The description provided under a group (e.g., "For the finance team") should appear in the generated dbt docs

### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

### Additional context
Is this feature database-specific? Which database(s) is/are relevant? Please include any other relevant context here.

### Who will this benefit?
What kind of use case will this feature be useful for? Please be specific and provide examples, this will help us prioritize properly.

### Are you interested in contributing this feature?
Let us know if you want to write some code, and how we can help.

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.