Skip to content

Commit

Permalink
Merge pull request #1830 from dlt-hub/devel
Browse files Browse the repository at this point in the history
Merge broken docs fix to master
  • Loading branch information
sh-rp authored Sep 17, 2024
2 parents 1750663 + fcc4c45 commit 3bb7d25
Show file tree
Hide file tree
Showing 13 changed files with 74 additions and 181 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for considering contributing to **dlt**! We appreciate your help in ma

## Table of Contents

1. [Getting Started](#getting-started)
1. [Getting Started](#intro)
2. [Submitting Changes](#submitting-changes)
3. [Adding or updating core dependencies](#adding-or-updating-core-dependencies)
4. [Linting](#linting)
Expand Down
11 changes: 5 additions & 6 deletions docs/website/docs/build-a-pipeline-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ keywords: [getting started, quick start, basics]
# Building data pipelines with `dlt`, from basic to advanced

This in-depth overview will take you through the main areas of pipelining with `dlt`. Go to the
related pages you are instead looking for the [quickstart](getting-started.md), or the
[walkthroughs](walkthroughs).
related pages you are instead looking for the [quickstart](./intro.md).

## Why build pipelines with `dlt`?

Expand Down Expand Up @@ -49,8 +48,8 @@ normalize, and evolve your data schemas, enabling seamless data integration and
For example, let's consider a scenario where you want to load a list of objects into a DuckDB table
named "three". With `dlt`, you can create a pipeline and run it with just a few lines of code:

1. [Create a pipeline](walkthroughs/create-a-pipeline.md) to the [destination](dlt-ecosystem/destinations).
1. Give this pipeline data and [run it](walkthroughs/run-a-pipeline.md).
1. [Create a pipeline](./walkthroughs/create-a-pipeline.md) to the [destination](dlt-ecosystem/destinations).
1. Give this pipeline data and [run it](./walkthroughs/run-a-pipeline.md).

```py
import dlt
Expand Down Expand Up @@ -378,7 +377,7 @@ processing and loading the data. Exporting schema files enables you to modify th
adjustments to the schema as needed. You can then import the modified schema files back into `dlt` to
use them in your pipeline.

Read more: [Adjust a schema docs.](walkthroughs/adjust-a-schema.md)
Read more: [Adjust a schema docs.](./walkthroughs/adjust-a-schema.md)

## Governance Support in `dlt` Pipelines

Expand All @@ -400,7 +399,7 @@ define the structure of normalized data and guide the processing and loading of
predefined schemas, pipelines maintain data integrity and facilitate standardized data handling
practices.

Read more: [Adjust a schema docs.](walkthroughs/adjust-a-schema.md)
Read more: [Adjust a schema docs.](./walkthroughs/adjust-a-schema.md)

### Schema evolution

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/destinations/bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ bigquery_adapter(my_resource, partition="partition_column_name")
my_resource = bigquery_adapter(my_resource, partition="partition_column_name")
```

Refer to the [full API specification](../../api_reference/destinations/impl/bigquery/bigquery_adapter.md) for more details.
Refer to the [full API specification](../../api_reference/destinations/impl/bigquery/bigquery_adapter) for more details.

<!--@@@DLT_TUBA bigquery-->

Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ print(pipeline.last_trace.last_normalize_info)

### Prerequisites

Please make sure the `dlt` library is installed. Refer to the [installation guide](../../../getting-started).
Please make sure the `dlt` library is installed. Refer to the [installation guide](../../../intro).

### Initialize the filesystem source

Expand Down
4 changes: 2 additions & 2 deletions docs/website/docs/dlt-ecosystem/verified-sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Planning to use `dlt` in production and need a source that isn't listed? We're h
### Core sources

<DocCardList items={useCurrentSidebarCategory().items.filter(
item => item.label === '30+ SQL Databases' || item.label === 'REST APIs' || item.label === 'Filesystem & buckets'
item => item.label === '30+ SQL Databases' || item.label === 'REST APIs' || item.label === 'Filesystem & cloud storage'
)} />

### Verified sources
Expand All @@ -24,7 +24,7 @@ If you couldn't find a source implementation, you can easily create your own, ch
:::

<DocCardList items={useCurrentSidebarCategory().items.filter(
item => item.label !== '30+ SQL Databases' && item.label !== 'REST API generic source'&& item.label !== 'Filesystem & buckets'
item => item.label !== '30+ SQL Databases' && item.label !== 'REST APIs' && item.label !== 'Filesystem & cloud storage'
)} />

### What's the difference between core and verified sources?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Running this pipeline will create two tables in the DuckDB: `posts` and `comment

### Prerequisites

Please make sure the `dlt` library is installed. Refer to the [installation guide](../../../getting-started).
Please make sure the `dlt` library is installed. Refer to the [installation guide](../../../intro).

### Initialize the REST API source

Expand Down Expand Up @@ -309,7 +309,7 @@ A resource configuration is used to define a [dlt resource](../../../general-usa
- `include_from_parent`: A list of fields from the parent resource to be included in the resource output. See the [resource relationships](#include-fields-from-the-parent-resource) section for more details.
- `selected`: A flag to indicate if the resource is selected for loading. This could be useful when you want to load data only from child resources and not from the parent resource.
You can also pass additional resource parameters that will be used to configure the dlt resource. See [dlt resource API reference](../../../api_reference/extract/decorators.md#resource) for more details.
You can also pass additional resource parameters that will be used to configure the dlt resource. See [dlt resource API reference](../../../api_reference/extract/decorators#resource) for more details.
### Endpoint configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/general-usage/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Postgres ignore it when creating tables.
Variant columns are generated by a normalizer when it encounters data item with type that cannot be
coerced in existing column. Please see our [`coerce_row`](https://github.com/dlt-hub/dlt/blob/7d9baf1b8fdf2813bcf7f1afe5bb3558993305ca/dlt/common/schema/schema.py#L205) if you are interested to see how internally it works.

Let's consider our [getting started](../getting-started#quick-start) example with slightly different approach,
Let's consider our [getting started](../intro) example with slightly different approach,
where `id` is an integer type at the beginning

```py
Expand Down
108 changes: 0 additions & 108 deletions docs/website/docs/getting-started.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/website/docs/tutorial/load-data-from-an-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Load package 1692364844.460054 is LOADED and contains no failed jobs

### Explore the data

To allow sneak peek and basic discovery you can take advantage of [built-in integration with Strealmit](reference/command-line-interface#show-tables-and-data-in-the-destination):
To allow sneak peek and basic discovery you can take advantage of [built-in integration with Strealmit](../reference/command-line-interface#show-tables-and-data-in-the-destination):

```sh
dlt pipeline quick_start show
Expand Down Expand Up @@ -558,7 +558,7 @@ That's it! Now you have a reusable source that can load data from any GitHub rep

## What’s next

Congratulations on completing the tutorial! You've come a long way since the [getting started](../getting-started) guide. By now, you've mastered loading data from various GitHub API endpoints, organizing resources into sources, managing secrets securely, and creating reusable sources. You can use these skills to build your own pipelines and load data from any source.
Congratulations on completing the tutorial! You've come a long way since the [getting started](../intro) guide. By now, you've mastered loading data from various GitHub API endpoints, organizing resources into sources, managing secrets securely, and creating reusable sources. You can use these skills to build your own pipelines and load data from any source.

Interested in learning more? Here are some suggestions:
1. You've been running your pipelines locally. Learn how to [deploy and run them in the cloud](../walkthroughs/deploy-a-pipeline/).
Expand Down
16 changes: 10 additions & 6 deletions docs/website/netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,31 @@ to = "/docs/intro"
from = "/docs"
to = "/docs/intro"

[[redirects]]
from = "/docs/getting-started"
to = "/docs/intro"

[[redirects]]
from = "/docs/dlt-ecosystem"
to = "/docs/dlt-ecosystem/verified-sources"

[[redirects]]
from = "/docs/general-usage/credentials/config_providers"
to = "/docs/general-usage/credentials"
to = "/docs/general-usage/credentials/setup"

[[redirects]]
from = "/docs/general-usage/credentials/configuration"
to = "/docs/general-usage/credentials/setup"

[[redirects]]
from = "/docs/general-usage/credentials/config_specs"
to = "/docs/general-usage/credentials/complex_types"
status = 301

[[redirects]]
from = "/docs/tutorial/intro"
to = "docs/tutorial/load-data-from-an-api"

[[redirects]]
from = "/docs/tutorial/grouping-resources"
to = "docs/tutorial/load-data-from-an-api"

[[redirects]]
from = "/docs/general-usage/credentials/config_specs"
to = "/docs/general-usage/credentials"
status = 301
90 changes: 41 additions & 49 deletions docs/website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -94,67 +94,59 @@ const sidebars = {
type: 'category',
label: '30+ SQL Databases',
description: 'PostgreSQL, MySQL, MS SQL, BigQuery, Redshift, and more',
link: {
link: {
type: 'doc',
id: 'dlt-ecosystem/verified-sources/sql_database/index',
},
},
items: [
'dlt-ecosystem/verified-sources/sql_database/setup',
'dlt-ecosystem/verified-sources/sql_database/configuration',
'dlt-ecosystem/verified-sources/sql_database/usage',
'dlt-ecosystem/verified-sources/sql_database/troubleshooting',
'dlt-ecosystem/verified-sources/sql_database/advanced'
'dlt-ecosystem/verified-sources/sql_database/advanced',
]
},

'dlt-ecosystem/verified-sources/airtable',
'dlt-ecosystem/verified-sources/amazon_kinesis',
'dlt-ecosystem/verified-sources/arrow-pandas',
'dlt-ecosystem/verified-sources/asana',
'dlt-ecosystem/verified-sources/chess',
'dlt-ecosystem/verified-sources/facebook_ads',
'dlt-ecosystem/verified-sources/freshdesk',
'dlt-ecosystem/verified-sources/github',
'dlt-ecosystem/verified-sources/google_ads',
'dlt-ecosystem/verified-sources/google_analytics',
'dlt-ecosystem/verified-sources/google_sheets',
'dlt-ecosystem/verified-sources/hubspot',
'dlt-ecosystem/verified-sources/inbox',
'dlt-ecosystem/verified-sources/jira',
'dlt-ecosystem/verified-sources/kafka',
'dlt-ecosystem/verified-sources/matomo',
'dlt-ecosystem/verified-sources/mongodb',
'dlt-ecosystem/verified-sources/mux',
'dlt-ecosystem/verified-sources/notion',
'dlt-ecosystem/verified-sources/personio',
'dlt-ecosystem/verified-sources/pg_replication',
'dlt-ecosystem/verified-sources/pipedrive',
'dlt-ecosystem/verified-sources/openapi-generator',
'dlt-ecosystem/verified-sources/salesforce',
'dlt-ecosystem/verified-sources/scrapy',
'dlt-ecosystem/verified-sources/shopify',
'dlt-ecosystem/verified-sources/slack',
'dlt-ecosystem/verified-sources/strapi',
'dlt-ecosystem/verified-sources/stripe',
'dlt-ecosystem/verified-sources/workable',
'dlt-ecosystem/verified-sources/zendesk',
{
type: 'category',
label: 'All verified sources',
description: 'All our verified sources',
label: 'REST API helpers',
link: {
type: 'doc',
id: 'general-usage/http/overview',
},
items: [
'dlt-ecosystem/verified-sources/airtable',
'dlt-ecosystem/verified-sources/amazon_kinesis',
'dlt-ecosystem/verified-sources/arrow-pandas',
'dlt-ecosystem/verified-sources/asana',
'dlt-ecosystem/verified-sources/chess',
'dlt-ecosystem/verified-sources/facebook_ads',
'dlt-ecosystem/verified-sources/freshdesk',
'dlt-ecosystem/verified-sources/github',
'dlt-ecosystem/verified-sources/google_ads',
'dlt-ecosystem/verified-sources/google_analytics',
'dlt-ecosystem/verified-sources/google_sheets',
'dlt-ecosystem/verified-sources/hubspot',
'dlt-ecosystem/verified-sources/inbox',
'dlt-ecosystem/verified-sources/jira',
'dlt-ecosystem/verified-sources/kafka',
'dlt-ecosystem/verified-sources/matomo',
'dlt-ecosystem/verified-sources/mongodb',
'dlt-ecosystem/verified-sources/mux',
'dlt-ecosystem/verified-sources/notion',
'dlt-ecosystem/verified-sources/personio',
'dlt-ecosystem/verified-sources/pg_replication',
'dlt-ecosystem/verified-sources/pipedrive',
'dlt-ecosystem/verified-sources/openapi-generator',
'dlt-ecosystem/verified-sources/salesforce',
'dlt-ecosystem/verified-sources/scrapy',
'dlt-ecosystem/verified-sources/shopify',
'dlt-ecosystem/verified-sources/slack',
'dlt-ecosystem/verified-sources/strapi',
'dlt-ecosystem/verified-sources/stripe',
'dlt-ecosystem/verified-sources/workable',
'dlt-ecosystem/verified-sources/zendesk',
{
type: 'category',
label: 'REST API helpers',
link: {
type: 'doc',
id: 'general-usage/http/overview',
},
items: [
'general-usage/http/rest-client',
'general-usage/http/requests',
]
},
'general-usage/http/rest-client',
'general-usage/http/requests',
]
},
'walkthroughs/add-a-verified-source',
Expand Down
Loading

0 comments on commit 3bb7d25

Please sign in to comment.