Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Simpler Examples, generate examples pages from actual examples code #1134

Merged
merged 20 commits into from
Apr 3, 2024

Conversation

sh-rp
Copy link
Collaborator

@sh-rp sh-rp commented Mar 22, 2024

Description

In this PR we fully deduplicate the examples. We generate the examples pages in the docs based on the code in the docs/examples folder, not vice versa.

TODO:

  • Tests

Copy link

netlify bot commented Mar 22, 2024

Deploy Preview for dlt-hub-docs canceled.

Name Link
🔨 Latest commit 852987c
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/660d3050a1801300084a619b

@sh-rp sh-rp linked an issue Mar 25, 2024 that may be closed by this pull request
@sh-rp sh-rp added the documentation Improvements or additions to documentation label Mar 25, 2024
@sh-rp sh-rp self-assigned this Mar 25, 2024
sh-rp added 11 commits March 25, 2024 15:55
# Conflicts:
#	docs/examples/connector_x_arrow/load_arrow.py
#	docs/examples/custom_destination_bigquery/custom_destination_bigquery.py
#	docs/examples/google_sheets/google_sheets.py
#	docs/examples/incremental_loading/incremental_loading.py
#	docs/examples/pdf_to_weaviate/pdf_to_weaviate.py
#	docs/examples/transformers/transformers.py
make examples raise in case of failed loads
@sh-rp sh-rp marked this pull request as ready for review March 25, 2024 18:04
@AstrakhantsevaAA AstrakhantsevaAA self-assigned this Mar 26, 2024
@@ -0,0 +1,72 @@
"""
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

note

burnash
burnash previously approved these changes Apr 3, 2024
Copy link
Collaborator

@burnash burnash left a comment

Choose a reason for hiding this comment

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

LGTM

- How to get arrow tables from [connector X](https://github.com/sfu-db/connector-x) and yield them.
- That merge and incremental loads work with arrow tables.
- How to enable [incremental loading](../general-usage/incremental-loading) for efficient data extraction.
- How to use build in ConnectionString credentials.
Copy link
Contributor

Choose a reason for hiding this comment

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

so we don't have Setup: Running this example on your machine section anymore?
do you think it's useless or it difficult to add in this implementation?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it was a feedback from @burnash (at least if i recall correctly) to make these pages more concise. I can add this section back in though, i am not super opinionated on this.

@sh-rp sh-rp dismissed stale reviews from AstrakhantsevaAA and burnash via 852987c April 3, 2024 10:32
@sh-rp sh-rp merged commit 6bf1940 into devel Apr 3, 2024
40 of 44 checks passed
@sh-rp sh-rp deleted the d#/simpler_examples branch April 17, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Docs: Simplify examples
3 participants