-
Notifications
You must be signed in to change notification settings - Fork 186
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: update the introduction, add the rest_api tutorial #1729
Conversation
✅ Deploy Preview for dlt-hub-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
34378fe
to
2368b2d
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.
haven't fully reviewed everything yet but these are the initial comments
docs/website/docs/intro.md
Outdated
@@ -124,18 +158,18 @@ external APIs, backends, or containers, scales on micro and large infra alike. | |||
- User-friendly, declarative interface that removes knowledge obstacles for beginners | |||
while empowering senior professionals. | |||
|
|||
## Getting started with `dlt` | |||
1. Dive into our [Getting started guide](getting-started.md) for a quick intro to the essentials of `dlt`. | |||
## Getting started with dlt |
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.
Just a note to revisit these steps after we finalise the structure of the docs
- Python 3.9 or higher installed | ||
- Virtual environment set up | ||
|
||
## Installing dlt |
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.
I think I would just put this into the prerequisites category vs having it's own section.
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.
some more comments, overall I really like the flow of the tutorial!
You should see the output of the pipeline execution in the terminal. The output will also diplay the location of the DuckDB database file where the data is stored: | ||
|
||
```sh | ||
Pipeline rest_api_pokemon load step completed in 1.08 seconds |
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.
As mentioned above this should be the Github API throughout the tutorial
Co-authored-by: Akela Drissner-Schmid <[email protected]>
Co-authored-by: Akela Drissner-Schmid <[email protected]>
Co-authored-by: Akela Drissner-Schmid <[email protected]>
Co-authored-by: Akela Drissner-Schmid <[email protected]>
Co-authored-by: Akela Drissner-Schmid <[email protected]>
a76e49a
to
dd488e0
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.
just a few minor changes to the intro, otherwise looks good
Co-authored-by: Akela Drissner-Schmid <[email protected]>
Co-authored-by: Akela Drissner-Schmid <[email protected]>
d317c2e
to
ed6153f
Compare
This reverts commit fc75ccb.
This PR:
Resolves #1724