From c283cee3f815e0914e95c5b06d4f1762e08e6a4b Mon Sep 17 00:00:00 2001 From: Alena Astrakhantseva Date: Tue, 26 Nov 2024 15:24:29 +0100 Subject: [PATCH] Move "dlt in notebooks" (#2096) * move notebooks page to run pipelines, move streamlit creds to streamlit page * remove notebooks page from sidebar --- docs/website/docs/dlt-ecosystem/notebooks.md | 27 ------------------- .../general-usage/dataset-access/streamlit.md | 12 +++++++++ .../docs/walkthroughs/run-a-pipeline.md | 19 ++++++++++++- docs/website/sidebars.js | 1 - 4 files changed, 30 insertions(+), 29 deletions(-) delete mode 100644 docs/website/docs/dlt-ecosystem/notebooks.md diff --git a/docs/website/docs/dlt-ecosystem/notebooks.md b/docs/website/docs/dlt-ecosystem/notebooks.md deleted file mode 100644 index 4486b81b68..0000000000 --- a/docs/website/docs/dlt-ecosystem/notebooks.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: dlt in notebooks -description: Run dlt in notebooks like Colab, Databricks or Jupyter -keywords: [notebook, jupyter] ---- -# dlt in notebooks - -## Colab -You'll need to install `dlt` like any other dependency: -```sh -!pip install dlt -``` - -You can configure secrets using **Secrets** sidebar. Just create a variable with the name `secrets.toml` and paste -the content of the **toml** file from your `.dlt` folder into it. We support `config.toml` variable as well. - -:::note -`dlt` will not reload the secrets automatically. Please restart your interpreter in Colab options when you add/change -content of the variables above. -::: - -## Streamlit -`dlt` will look for `secrets.toml` and `config.toml` in the `.dlt` folder. If `secrets.toml` are not found, it will use -`secrets.toml` from `.streamlit` folder. -If you run locally, maintain your usual `.dlt` folder. When running on streamlit cloud, paste the content of `dlt` -`secrets.toml` into the `streamlit` secrets. - diff --git a/docs/website/docs/general-usage/dataset-access/streamlit.md b/docs/website/docs/general-usage/dataset-access/streamlit.md index 32589d8e23..2d76aac660 100644 --- a/docs/website/docs/general-usage/dataset-access/streamlit.md +++ b/docs/website/docs/general-usage/dataset-access/streamlit.md @@ -31,6 +31,18 @@ dlt pipeline {pipeline_name} show Use the pipeline name you defined in your Python code with the `pipeline_name` argument. If you are unsure, you can use the `dlt pipeline --list` command to list all pipelines. +## Credentials + +`dlt` will look for `secrets.toml` and `config.toml` in the `.dlt` folder. + +If `secrets.toml` are not found, it will use +`secrets.toml` from `.streamlit` folder. + +If you run locally, maintain your usual `.dlt` folder. + +When running on streamlit cloud, paste the content of `dlt` +`secrets.toml` into the `streamlit` secrets. + ## Inspecting your data You can now inspect the schema and your data. Use the left sidebar to switch between: diff --git a/docs/website/docs/walkthroughs/run-a-pipeline.md b/docs/website/docs/walkthroughs/run-a-pipeline.md index 49abe8675f..3c0e30ccf3 100644 --- a/docs/website/docs/walkthroughs/run-a-pipeline.md +++ b/docs/website/docs/walkthroughs/run-a-pipeline.md @@ -140,7 +140,24 @@ destination, etc. Please refer to [Running in production](../running-in-production/running.md#inspect-and-save-the-load-info-and-trace) for more details. -## 5. Detect and handle problems +## Run dlt in Notebooks + +### Colab +You'll need to install `dlt` like any other dependency: +```sh +!pip install dlt +``` + +You can configure secrets using **Secrets** sidebar. Just create a variable with the name `secrets.toml` and paste +the content of the **toml** file from your `.dlt` folder into it. We support `config.toml` variable as well. + +:::note +`dlt` will not reload the secrets automatically. Please restart your interpreter in Colab options when you add/change +content of the variables above. +::: + + +## Troubleshooting What happens if something goes wrong? In most cases, the `dlt` `run` command raises exceptions. We put a lot of effort into making the exception messages easy to understand. Reading them is the first step diff --git a/docs/website/sidebars.js b/docs/website/sidebars.js index bff2fcc508..274f3e82b3 100644 --- a/docs/website/sidebars.js +++ b/docs/website/sidebars.js @@ -271,7 +271,6 @@ const sidebars = { 'general-usage/full-loading', ] }, - 'dlt-ecosystem/notebooks' ] }, {