Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Nov 11, 2025

About

Pull and enhance documentation from dlt-cratedb 1. It includes:

  • Overview about supported features
  • Usage guide based on the canonical dlt init chess example

Preview

References

/cc @karynzv, @zolbatar, @grbade

Footnotes

  1. https://github.com/crate/dlt-cratedb/blob/v0.0.2/docs/cratedb.md.

@coderabbitai
Copy link

coderabbitai bot commented Nov 11, 2025

Walkthrough

Documentation-only updates for the dlt CrateDB integration: expanded docs/integrate/dlt/index.md with a "Supported features" section, updated links and resources, and added a new docs/integrate/dlt/usage.md providing step-by-step installation, configuration, Docker usage, and example commands.

Changes

Cohort / File(s) Summary
dlt integration index edits
docs/integrate/dlt/index.md
Replaced "Learn" with "Supported features"; added multi-section feature blocks (Data loading, Datasets, File formats, Column types, Column hints, File staging, dbt support, dlt state sync); updated "See also" grid and Resources wording (e.g., dlt-cratedb, related ingestr); added toctree and CrateDB-specific create-schema note (CRATEDB-14601); updated external link captions/targets and minor wording tweaks.
New usage guide
docs/integrate/dlt/usage.md
Added a comprehensive usage guide covering installation (pip install dlt-cratedb), dlt init project setup, editing pipeline code (dataset name, dlt_cratedb import), .dlt/secrets.toml configuration and connection-string alternative, Docker instructions to start CrateDB, example run commands, and exploration/notes for CrateDB schema limitations and known errors.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Documentation-only changes, consistent pattern and no code edits.
  • Review focus:
    • Verify command snippets and Docker examples in docs/integrate/dlt/usage.md.
    • Validate TOML snippets and connection-string alternatives in .dlt/secrets.toml examples.
    • Check updated external links and CRATEDB-14601 note in docs/integrate/dlt/index.md.

Possibly related PRs

Suggested labels

new content

Suggested reviewers

  • hammerhead
  • surister
  • kneth

Poem

🐰 A rabbit hops through README glades,
Pip installs and Docker aids,
Secrets.toml tucked in a nook,
Pipelines run — the data's took,
Hooray for docs that lay the blades!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: pulling and enhancing dlt documentation from the upstream dlt-cratedb repository into the CrateDB guide, covering README and usage guide content.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description clearly relates to the changeset, describing the integration of dlt-cratedb documentation with specific references to supported features overview and usage guide.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dlt

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@amotl amotl marked this pull request as ready for review November 11, 2025 18:59
coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added reorganize Moving content around, inside and between other systems. maintenance C'est la vie. labels Nov 11, 2025
coderabbitai[bot]

This comment was marked as resolved.

Includes:
- Overview about supported features
- Usage guide based on `dlt init`
Copy link
Member

@surister surister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@amotl amotl merged commit 3c18f06 into main Nov 12, 2025
3 checks passed
@amotl amotl deleted the dlt branch November 12, 2025 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance C'est la vie. reorganize Moving content around, inside and between other systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants