Skip to content

Commit

Permalink
return "credentials" as a section slug
Browse files Browse the repository at this point in the history
  • Loading branch information
AstrakhantsevaAA committed Oct 25, 2023
1 parent 54f4750 commit 382185f
Show file tree
Hide file tree
Showing 35 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/destinations/duckdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ p = dlt.pipeline(pipeline_name='chess', destination='duckdb', dataset_name='ches

This destination accepts database connection strings in format used by [duckdb-engine](https://github.com/Mause/duckdb_engine#configuration).

You can configure a DuckDB destination with [secret / config values](../../general-usage/configuration/credentials.md) (e.g. using a `secrets.toml` file)
You can configure a DuckDB destination with [secret / config values](../../general-usage/credentials) (e.g. using a `secrets.toml` file)
```toml
destination.duckdb.credentials=duckdb:///_storage/test_quack.duckdb
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ For more information, read the
> Optionally, you can also input "base_id" and "table_names" in the script, as in the pipeline
> example.
For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/asana.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ For more information, read the
[destination documentation](../../dlt-ecosystem/destinations) to add credentials for your chosen
destination. This will ensure that your data is properly routed to its final destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/chess.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To add credentials to your destination, follow the instructions in the
[destination](../../dlt-ecosystem/destinations) documentation. This will ensure that your data is
properly routed to its final destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ For more information, read the

1. Replace the value of the "account id" with the one [copied above](#grab-account-id).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ For more information, read the
add credentials for your chosen destination, ensuring proper routing of your data to the final
destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ For more information, read the
1. To use queries from `.dlt/config.toml`, run the `simple_load_config()` function in
[pipeline example](https://github.com/dlt-hub/verified-sources/blob/master/sources/google_analytics_pipeline.py).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ For more information, read the
> Note: You have an option to pass "range_names" and "spreadsheet_identifier" directly to the
> google_spreadsheet function or in ".dlt/config.toml"
For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ For more information, read the

1. Enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ For more information, read the
add credentials for your chosen destination, ensuring proper routing of your data to the final
destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/matomo.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ For more information, read the

1. To monitor live events on a website, enter the `live_event_site_id` (usually it is same as `site_id`).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ For more information, read the
1. Replace the value of the "database" and "collections_names" with the ones
[copied above](#grab-database-and-collections).
For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)
## Run the pipeline
Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/mux.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ For more information, read the

1. Finally, enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/notion.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ For more information, read the
your chosen destination. This will ensure that your data is properly routed to its final
destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
4 changes: 2 additions & 2 deletions docs/website/docs/dlt-ecosystem/verified-sources/pipedrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ For more information, read the

1. Finally, enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down Expand Up @@ -266,7 +266,7 @@ verified source.

```python
load_data = pipedrive_source() # calls the source function
load_info = pipeline.run(load_info) #runs the pipeline with selected source configuration
load_info = pipeline.run(load_info) #runs the pipeline with selected source credentials
print(load_info)
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ For more information, read the
add credentials for your chosen destination, ensuring proper routing of your data to the final
destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ For more information, read the
add credentials for your chosen destination, ensuring proper routing of your data to the final
destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ For more information, read the

1. Finally, enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ For more information, read the
1. Finally, follow the instructions in [Destinations](../destinations/) to add credentials for your
chosen destination. This will ensure that your data is properly routed to its final destination.

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/strapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For more information, read the

1. Finally, enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/dlt-ecosystem/verified-sources/stripe.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For more information, read the

1. Finally, enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ For more information, read the

1. Finally, enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ For more information, read the
1. Finally, enter credentials for your chosen destination as per the [docs](../destinations/).

For more information, read the [General Usage: Credentials.](../../general-usage/configuration/credentials.md)
For more information, read the [General Usage: Credentials.](../../general-usage/credentials)

## Run the pipeline

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/examples/incremental_loading/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In this example, you'll find a Python script that interacts with the Zendesk Sup

We'll learn:

- How to pass [credentials](../../general-usage/configuration/credentials.md) as dict and how to type the `@dlt.source` function arguments.
- How to pass [credentials](../../general-usage/credentials) as dict and how to type the `@dlt.source` function arguments.
- How to set [the nesting level](../../general-usage/source#reduce-the-nesting-level-of-generated-tables).
- How to enable [incremental loading](../../general-usage/incremental-loading) for efficient data extraction.
- How to specify [the start and end dates](../../general-usage/incremental-loading#using-dltsourcesincremental-for-backfill) for the data loading and how to [opt-in to Airflow scheduler](../../general-usage/incremental-loading#using-airflow-schedule-for-backfill-and-incremental-loading) by setting `allow_external_schedulers` to `True`.
Expand Down
4 changes: 2 additions & 2 deletions docs/website/docs/general-usage/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ Describes the structure of normalized data (e.g. unpacked tables, column types,
instructions on how the data should be processed and loaded (i.e. it tells `dlt` about the content
of the data and how to load it into the destination).

## [Config](configuration/configuration.md)
## [Config](credentials/configuration.md)

A set of values that are passed to the pipeline at run time (e.g. to change its behavior locally vs.
in production).

## [Credentials](configuration/credentials.md)
## [Credentials](credentials/add_credentials.md)

A subset of configuration whose elements are kept secret and never shared in plain text.
4 changes: 2 additions & 2 deletions docs/website/docs/general-usage/resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ accepts following arguments:
> hint value. This let's you create table and column schemas depending on the data. See example in
> next section.
> 💡 You can mark some resource arguments as configuration and [credentials](configuration/credentials.md)
> 💡 You can mark some resource arguments as [configuration and credentials](credentials)
> values so `dlt` can pass them automatically to your functions.
### Define a schema with Pydantic
Expand Down Expand Up @@ -174,7 +174,7 @@ for row in generate_rows(20):
print(row)
```

You can mark some resource arguments as configuration and [credentials](configuration/credentials.md) values
You can mark some resource arguments as configuration and [credentials](credentials/add_credentials.md) values
so `dlt` can pass them automatically to your functions.

### Process resources with `dlt.transformer`
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 @@ -64,7 +64,7 @@ The default naming convention:
> 💡 Use simple, short small caps identifiers for everything!
The naming convention is [configurable](configuration/configuration.md) and users can easily create their own
The naming convention is [configurable](credentials) and users can easily create their own
conventions that i.e. pass all the identifiers unchanged if the destination accepts that (i.e.
DuckDB).

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ If you want to take full advantage of the `dlt` library, then we strongly sugges
- [Transform your data before loading](general-usage/resource#customize-resources) and see some [examples of customizations like column renames and anonymization](general-usage/customising-pipelines/renaming_columns).
- [Set up "last value" incremental loading](general-usage/incremental-loading#incremental_loading-with-last-value).
- [Set primary and merge keys, define the columns nullability and data types](general-usage/resource#define-schema).
- [Pass config and credentials into your sources and resources](general-usage/configuration/credentials.md).
- [Pass config and credentials into your sources and resources](general-usage/credentials).
- [Use built-in requests client](reference/performance#using-the-built-in-requests-client).
- [Run in production: inspecting, tracing, retry policies and cleaning up](running-in-production/running).
- [Run resources in parallel, optimize buffers and local storage](reference/performance.md)
2 changes: 1 addition & 1 deletion docs/website/docs/running-in-production/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ load.delete_completed_jobs=true
## Using slack to send messages

`dlt` provides basic support for sending slack messages. You can configure Slack incoming hook via
[secrets.toml or environment variables](../general-usage/configuration/credentials.md). Please note that **Slack
[secrets.toml or environment variables](../general-usage/credentials/config_providers). Please note that **Slack
incoming hook is considered a secret and will be immediately blocked when pushed to github
repository**. In `secrets.toml`:

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/walkthroughs/add-a-verified-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ the supported locations.
## 2. Adding credentials

For adding them locally or on your orchestrator, please see the following guide
[credentials](../general-usage/configuration/credentials.md).
[credentials](../general-usage/credentials).

## 3. Customize or write a pipeline script

Expand Down
10 changes: 5 additions & 5 deletions docs/website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,13 @@ const sidebars = {
link: {
type: 'generated-index',
title: 'Configuration',
slug: 'dlt-ecosystem/configuration',
slug: 'general-usage/credentials',
},
items: [
'general-usage/configuration/configuration',
'general-usage/configuration/credentials',
'general-usage/configuration/config_providers',
'general-usage/configuration/config_specs',
'general-usage/credentials/configuration',
'general-usage/credentials/add_credentials',
'general-usage/credentials/config_providers',
'general-usage/credentials/config_specs',
]
},
'reference/performance',
Expand Down

0 comments on commit 382185f

Please sign in to comment.