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: follow-up #1831

Merged
merged 2 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/website/docs/build-a-pipeline-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,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 @@ -377,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 @@ -399,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: 2 additions & 0 deletions docs/website/docs/dlt-ecosystem/destinations/bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,5 +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) for more details.

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

2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 @@ -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.
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/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const config = {
tagline: 'data load tool',
url: 'https://dlthub.com',
baseUrl: process.env.DOCUSAURUS_BASE_URL || '/docs',
onBrokenLinks: 'warn',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
favicon: 'img/favicon.ico',
staticDirectories: ['public', 'static'],
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
58 changes: 29 additions & 29 deletions docs/website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,6 @@ const sidebars = {
id: 'dlt-ecosystem/verified-sources/index',
},
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',
{
type: 'category',
label: 'Filesystem & cloud storage',
Expand All @@ -83,22 +77,6 @@ const sidebars = {
'dlt-ecosystem/verified-sources/filesystem/advanced',
]
},
'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',
{
type: 'category',
label: 'REST APIs',
Expand All @@ -112,26 +90,48 @@ const sidebars = {
'dlt-ecosystem/verified-sources/rest_api/advanced',
]
},
'dlt-ecosystem/verified-sources/openapi-generator',
'dlt-ecosystem/verified-sources/salesforce',
'dlt-ecosystem/verified-sources/scrapy',
'dlt-ecosystem/verified-sources/shopify',
{
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',
Expand Down
1 change: 1 addition & 0 deletions docs/website/tools/preprocess_docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,7 @@ function syncExamples() {
console.log(`Synced ${count} examples`)
}

fs.rmSync(MD_TARGET_DIR, {force: true, recursive: true})
syncExamples();
preprocess_docs();

Expand Down
Loading