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

data access documentation #2006

Merged
merged 10 commits into from
Nov 25, 2024
Merged

data access documentation #2006

merged 10 commits into from
Nov 25, 2024

Conversation

sh-rp
Copy link
Collaborator

@sh-rp sh-rp commented Oct 30, 2024

Description

Direct access to the changed section: https://deploy-preview-2006--dlt-hub-docs.netlify.app/docs/devel/general-usage/dataset-access/

This PR adds the docs for our dataset features. This updated section will replace the "exploring-the-data" section currently in the docs. The exploring-the-data pages is now split across three new pages:

  • general-usage/dataset-access/streamlit - which I also updated to remove errors and add some clarifications. Links in existing docs are also updated
  • general-usage/dataset-access/sql-client - which explains how our sql client works, how you can use it if you for some reason need to and also has a section with some internals about how it works on filesystem which I have linked to from other places so users understand what is going on
  • general-usage/dataset-access/data-quality-dashboard - this I just copied over unmodified. I'm not sure that this page is in the right place now. I also think it is very general and could need some more concrete content, but that is out of scope for this PR. We may choose to move it though, @AstrakhantsevaAA what do you think?

Then there are two new pages:

  • general-usage/dataset-access/dataset - How to access data with our datasets with many examples, I quite like the structure
  • general-usage/dataset-access/ibis-backend - How to get a native ibis backend from a dataset.

TODO:

  • replace all references to._datasetwith .dataset once renamed on devel.
  • If we manage to put ibis expression support for datasets into the next release, we need to add usage info for this too
  • If we add schema_name to the dataset factory function on the pipeline, document this too.

@sh-rp sh-rp added the documentation Improvements or additions to documentation label Oct 30, 2024
Copy link

netlify bot commented Oct 30, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 4f4ccd7
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/674461a7d770d700086c7afb
😎 Deploy Preview https://deploy-preview-2006--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sh-rp sh-rp force-pushed the docs/dataset-documentation branch 2 times, most recently from a00f21a to 4b63012 Compare November 4, 2024 19:21
@sh-rp sh-rp changed the title WIP - data access documentation data access documentation Nov 5, 2024
@sh-rp sh-rp marked this pull request as ready for review November 18, 2024 16:10
@sh-rp sh-rp self-assigned this Nov 19, 2024
@sh-rp sh-rp linked an issue Nov 19, 2024 that may be closed by this pull request
5 tasks
Copy link
Contributor

@AstrakhantsevaAA AstrakhantsevaAA left a comment

Choose a reason for hiding this comment

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

Very good docs! Easy to read and understand 👍
left a bunch of small changes, apply them or not, up to you

@sh-rp sh-rp force-pushed the docs/dataset-documentation branch from 047ad58 to 3d952fe Compare November 25, 2024 11:33
@sh-rp sh-rp merged commit bc25a60 into devel Nov 25, 2024
49 checks passed
@sh-rp sh-rp deleted the docs/dataset-documentation branch November 25, 2024 12:47
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
None yet
Development

Successfully merging this pull request may close these issues.

Release Dataset Feature
2 participants