ClickHouse / ClickHouse/dbt-clickhouse

Improve config docs and add references in the dbt docs site

Open
#649 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
362
Forks
177
Avg merge
2d 10h
Merged PRs (30d)
8

Description

Two docs improvements:
- Make it easier to digest the configs available inside `profiles.yml`: Separate configs by type and include reference examples for local and cloud deployments.
- in dbt docs site, add links back to the complete details of each of the available materializations.

Contributor guide

Open the contributing guide

Research direction

Start by locating the profiles.yml configuration documentation and the materialization pages in the dbt docs site. Separate the profiles.yml configs by type with local and cloud reference examples, and add links from each materialization entry to its complete details. Done means both documentation areas are easier to navigate and the new references resolve correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
databases, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.