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: update the introduction, add the rest_api tutorial #1729

Merged
merged 35 commits into from
Sep 14, 2024

Conversation

burnash
Copy link
Collaborator

@burnash burnash commented Aug 22, 2024

This PR:

  • updates the documentation introduction page
  • adds a rest_api source tutorial
  • adds stubs for sql & filesystem sources tutorials.

Resolves #1724

@burnash burnash added the documentation Improvements or additions to documentation label Aug 22, 2024
Copy link

netlify bot commented Aug 22, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 3c162ab
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/66e5639cf4cd6e00083ca5ce
😎 Deploy Preview https://deploy-preview-1729--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.

@burnash burnash changed the title Docs: add rest_api tutorial Docs: update introduction, add rest_api tutorial Aug 22, 2024
@burnash burnash changed the title Docs: update introduction, add rest_api tutorial Docs: update the introduction, add the rest_api tutorial Aug 22, 2024
@rudolfix rudolfix added the sprint Marks group of tasks with core team focus at this moment label Aug 22, 2024
@burnash burnash force-pushed the enh/docs/introduction-rest-sql-file branch 7 times, most recently from 34378fe to 2368b2d Compare August 23, 2024 20:34
@akelad akelad requested review from VioletM and akelad August 26, 2024 07:24
@VioletM VioletM linked an issue Aug 27, 2024 that may be closed by this pull request
Copy link
Contributor

@akelad akelad left a 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 Show resolved Hide resolved
docs/website/docs/intro.md Outdated Show resolved Hide resolved
@@ -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
Copy link
Contributor

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

docs/website/docs/intro.md Outdated Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
- Python 3.9 or higher installed
- Virtual environment set up

## Installing dlt
Copy link
Contributor

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.

Copy link
Contributor

@akelad akelad left a 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
Copy link
Contributor

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

docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
docs/website/docs/tutorial/rest-api.md Outdated Show resolved Hide resolved
@burnash burnash force-pushed the enh/docs/introduction-rest-sql-file branch from a76e49a to dd488e0 Compare September 11, 2024 21:21
Copy link
Contributor

@akelad akelad left a 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

docs/website/docs/intro.md Outdated Show resolved Hide resolved
docs/website/docs/intro.md Outdated Show resolved Hide resolved
@burnash burnash force-pushed the enh/docs/introduction-rest-sql-file branch from d317c2e to ed6153f Compare September 13, 2024 14:33
@burnash burnash merged commit eb4b1ba into devel Sep 14, 2024
51 checks passed
@burnash burnash deleted the enh/docs/introduction-rest-sql-file branch September 14, 2024 11:08
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 sprint Marks group of tasks with core team focus at this moment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Docs | REST API tutorial Docs | Intro makeover
3 participants