-
Notifications
You must be signed in to change notification settings - Fork 188
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
Restructure intro, getting started and tutorial #702
Conversation
✅ Deploy Preview for dlt-hub-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
c48c46b
to
04713a5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wow huge work!
imo:
- Now I don’t really see the differences between the tutorial and how-to guides. if we combine them, nothing will change.
- The Getting Started page has also lost its relevance. they are now similar to the Introduction page. maybe makes sense to merge them too?
update: at least the title Load data with API do not reflect the content. I got the idea of the tutorial section: it is something between How-to and using-dlt. mb rename it to "Load data with append, replace, merge mode"
@AstrakhantsevaAA thanks for the comment!
There should be a difference in the level of specificity: tutorial is a more general guide that teaches the core concepts, where how-to guides are more specific steps of instructions.
|
I believe an uninitiated user won't know what is append, replace and merge: the point of the first part is to teach them what that actually is and why they may need to use different loading modes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- PDF to weaviate is not visible in the index in the walkthrough
- I'd move it to examples. it looks way more like example to me. and we have too many walkthroughs
- the test for the above does not pass
- we have two files
deploy_to_github_actions
anddispatch-to-multiple-tables
in the top level dir. (docs/website/docs) looks like a mistake
regarding content. tutorial is cool!
IMO removing the tabs with various examples from getting started is not a good idea. it showcases what you can do with dlt in a few lines of code and I was using it a lot when talking to users on slack to show how you can deal with pandas, csv or databases quickly. so practically I need that content somewhere at the top.
04713a5
to
50827ac
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In recent days, I have often heard positive feedback from users about Getting Started page, I quote, “it’s convenient that by going through one page you can generally understand how the tool works.” It was good that it briefly showed how the tool works, without going into too much detail.
The tutorial is needed for a deeper understanding of these principles
@AstrakhantsevaAA thanks for the feedback. The content from the getting started is still in the docs, I've moved it to the first part of the tutorial. My hypothesis is that it would not affect the understanding of the material. Another is that having a cohesive storyline also aids people in grasping dlt's key concepts fast. |
d3a8e29
to
cceec59
Compare
Description
This PR: