From 4ef3138c94d406a54127838f4bbbdeb8c36de6cf Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 11:51:05 -0500 Subject: [PATCH 01/12] Add structure --- src/segment-app/extensions/dbt.md | 3 +++ src/segment-app/extensions/git.md | 3 +++ src/segment-app/extensions/index.md | 8 ++++++++ 3 files changed, 14 insertions(+) create mode 100644 src/segment-app/extensions/dbt.md create mode 100644 src/segment-app/extensions/git.md create mode 100644 src/segment-app/extensions/index.md diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md new file mode 100644 index 0000000000..f9beffa3b4 --- /dev/null +++ b/src/segment-app/extensions/dbt.md @@ -0,0 +1,3 @@ +--- +title: dbt Integration +--- \ No newline at end of file diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md new file mode 100644 index 0000000000..70b755e153 --- /dev/null +++ b/src/segment-app/extensions/git.md @@ -0,0 +1,3 @@ +--- +title: Git Sync Integration +--- \ No newline at end of file diff --git a/src/segment-app/extensions/index.md b/src/segment-app/extensions/index.md new file mode 100644 index 0000000000..a00c09a174 --- /dev/null +++ b/src/segment-app/extensions/index.md @@ -0,0 +1,8 @@ +--- +title: Extensions +--- + +Extensions integrate third-party tools into your existing Segment Workspace to help you automate tasks. Using Extensions, you can sync models with dbt labs and manage versioning for Segment Workspace changes using GitHub repositories. + +> info "" +> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. \ No newline at end of file From 2080c4c95cc8103c026209b1e94f9ffc59137011 Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 12:31:56 -0500 Subject: [PATCH 02/12] dbt sync first pass --- src/segment-app/extensions/dbt.md | 51 ++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index f9beffa3b4..8675e2fb08 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -1,3 +1,52 @@ --- title: dbt Integration ---- \ No newline at end of file +--- + +Segment's dbt integration lets you use [Reverse ETL](/docs/connections/reverse-etl/) with your existing dbt labs models and syncs to help centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes. + +With Segment's dbt integration, you can: + +- Securely connect Segment to the GitHub repository that stores your dbt models. +- Use centralized dbt models to set up Reverse ETL. +- Trigger Reverse ETL syncs from dbt jobs. + + + +> info "" +> Extensions, including Segment's dbt integration, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. + +## Before you begin + +Keep the following in mind as you set up the dbt integration: + +- The integration supports [dbt Core v1.7](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.7){:target="_blank"}. +- You can use Snowflake, Databricks, RedShift, Postgres, and BigQuery as Reverse ETL sources. +- dbt models aren't synchronized from the dbt cloud. The model sync connects to a Git repository that loads models into Segment for use with Reverse ETL. + +## Set up Git dbt Models and dbt Cloud + +To set up the dbt integration, you'll need: + +- an existing dbt account with a Git repository +- (for job syncs:) dbt cloud with jobs already created + +### Git repository and dbt Models setup + +Follow these steps to connect the Git repository that stores your dbt Models: + +1. In your Segment Workspace, go to **Settings > Extensions**. +2. Click **Set up Git sync**. +3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key, then click **Next**. +4. In the **Connect source** window, select a Reverse ETL warehouse source from the dropdown, then click **Save**. + +After you've saved your setup, you can configure your Git repository's settings to your needs by changing the selecting the repository, branch, dbt version, default schema, and project path. + +### dbt Cloud setup + +You can also use dbt Cloud to schedule Reverse ETL syncs after a dbt Cloud job successfully runs. + +To set up dbt Cloud: + +1. In your Segment Workspace, go to **Settings > Extensions**. +2. Click **Manage dbt CLoud**. +3. Add your dbt Cloud API key, and, optionally, a custom subdomain. Click **Save**. From f48f68600c9472e7bc3a6503bcc515a5d493a124 Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 13:38:11 -0500 Subject: [PATCH 03/12] Add Reverse ETL steps --- src/segment-app/extensions/dbt.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index 8675e2fb08..28977ab28b 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -10,7 +10,7 @@ With Segment's dbt integration, you can: - Use centralized dbt models to set up Reverse ETL. - Trigger Reverse ETL syncs from dbt jobs. - +This page explains how to set up a dbt Model and then use the model with Reverse ETL. > info "" > Extensions, including Segment's dbt integration, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. @@ -34,7 +34,7 @@ To set up the dbt integration, you'll need: Follow these steps to connect the Git repository that stores your dbt Models: -1. In your Segment Workspace, go to **Settings > Extensions**. +1. In your Segment Workspace, navigate to **Settings > Extensions**. 2. Click **Set up Git sync**. 3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key, then click **Next**. 4. In the **Connect source** window, select a Reverse ETL warehouse source from the dropdown, then click **Save**. @@ -47,6 +47,23 @@ You can also use dbt Cloud to schedule Reverse ETL syncs after a dbt Cloud job s To set up dbt Cloud: -1. In your Segment Workspace, go to **Settings > Extensions**. +1. In your Segment Workspace, navigate to **Settings > Extensions**. 2. Click **Manage dbt CLoud**. 3. Add your dbt Cloud API key, and, optionally, a custom subdomain. Click **Save**. + +### Model syncs + +After you set up dbt, Segment runs an initial sync to load models from your connected Git repository. This initial sync lets you use the most recent models when you set up Reverse ETL. In addition to Segment's initial dbt sync, you can also trigger manual dbt model syncs. + +### Use a model with Reverse ETL + +After you've successfully set up dbt with a warehouse and connected to your Git repository, you can select dbt models for use with Reverse ETL by following these steps: + +1. In your Segment Workspace, navigate to **Connections > Sources** and select the Reverse ETL tab. +2. Click **+Add Reverse ETL source** , select your source, then click **Add Model**. +3. Click **dbt Models** as your modeling method, then select and preview a model from the dbt model dropdown. +4. Add a primary key, then click **Preview your model**. +5. Click **Next**. +6. Enter your **Model Name**, then click **Create Model**. + +To change a connected model, ensure that you've removed it from all active Reverse ETL syncs. \ No newline at end of file From c4db2845a878a72d13b22aa17491fab9e3acaf93 Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 14:40:55 -0500 Subject: [PATCH 04/12] More changes --- src/segment-app/extensions/dbt.md | 2 +- src/segment-app/extensions/git.md | 23 +++++++++++++++++++++-- src/segment-app/extensions/index.md | 5 +++-- 3 files changed, 25 insertions(+), 5 deletions(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index 28977ab28b..eb9b9e4ba0 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -1,5 +1,5 @@ --- -title: dbt Integration +title: dbt Extension --- Segment's dbt integration lets you use [Reverse ETL](/docs/connections/reverse-etl/) with your existing dbt labs models and syncs to help centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes. diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index 70b755e153..b58cd23568 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -1,3 +1,22 @@ --- -title: Git Sync Integration ---- \ No newline at end of file +title: Git Sync Extension +--- + +Segment's Git extension lets you manage versioning by syncing changes you make to Sources and Destinations from your Segment Workspace to a Git repository. + +> info "" +> Extensions, including Segment's dbt integration, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. + +## Set up Git sync + +Follow these steps to connect set up Git sync: + +1. In your Segment Workspace, navigate to **Settings > Extensions**. +2. Click **Set up Git sync**. +3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key, then click **Next**. + +## Working with Git syncs + +After you set up the Git sync integration for the first time, Segment performs an initial sync that sends source and destination information in your Segment Workspace to the Git repository you connected. + +You can run syncs at any time by clicking **Full resync** on the Git sync page. To disable Git sync from the Git sync page, switch the **Enabled** toggle to off. \ No newline at end of file diff --git a/src/segment-app/extensions/index.md b/src/segment-app/extensions/index.md index a00c09a174..b1edcb146f 100644 --- a/src/segment-app/extensions/index.md +++ b/src/segment-app/extensions/index.md @@ -2,7 +2,8 @@ title: Extensions --- -Extensions integrate third-party tools into your existing Segment Workspace to help you automate tasks. Using Extensions, you can sync models with dbt labs and manage versioning for Segment Workspace changes using GitHub repositories. +Extensions integrate third-party tools into your existing Segment Workspace to help you automate tasks. Using Extensions, you can sync models with dbt labs and manage versioning for Segment Workspace changes using Git repositories. > info "" -> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. \ No newline at end of file +> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. + From cc738924db98ca5cc0723ccac631f45162cfd073 Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 14:53:52 -0500 Subject: [PATCH 05/12] Update main page --- src/segment-app/extensions/index.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/segment-app/extensions/index.md b/src/segment-app/extensions/index.md index b1edcb146f..fcd69746df 100644 --- a/src/segment-app/extensions/index.md +++ b/src/segment-app/extensions/index.md @@ -2,8 +2,12 @@ title: Extensions --- -Extensions integrate third-party tools into your existing Segment Workspace to help you automate tasks. Using Extensions, you can sync models with dbt labs and manage versioning for Segment Workspace changes using Git repositories. +Extensions integrate third-party tools into your existing Segment Workspace to help you automate tasks. > info "" -> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. +> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. During Public Beta, Extensions is availability for Team and Developer plans only. [Reach out to Segment](mailto:friends@segment.com) if you're on a Business Tier plan and would like to participate in the Public Beta. +During public beta, Segment offers the following extensions: + +- [dbt models and dbt Cloud](/docs/segment-app/extensions/dbt), which let you sync models with dbt Labs +- [Git sync](/docs/segment-app/extensions/dbt), which you can use to manage versioning and track changes in your Segment Workspace From b6b3f78f975918f7de34024c2eadea461c90f5ad Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 14:56:10 -0500 Subject: [PATCH 06/12] More cleanup [netlify-build] --- src/segment-app/extensions/dbt.md | 4 ++-- src/segment-app/extensions/git.md | 6 +++--- src/segment-app/extensions/index.md | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index eb9b9e4ba0..773e10b51f 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -39,7 +39,7 @@ Follow these steps to connect the Git repository that stores your dbt Models: 3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key, then click **Next**. 4. In the **Connect source** window, select a Reverse ETL warehouse source from the dropdown, then click **Save**. -After you've saved your setup, you can configure your Git repository's settings to your needs by changing the selecting the repository, branch, dbt version, default schema, and project path. +After you've saved your setup, you can configure your Git repository's settings to your needs by changing the repository, branch, dbt version, default schema, and project path. ### dbt Cloud setup @@ -48,7 +48,7 @@ You can also use dbt Cloud to schedule Reverse ETL syncs after a dbt Cloud job s To set up dbt Cloud: 1. In your Segment Workspace, navigate to **Settings > Extensions**. -2. Click **Manage dbt CLoud**. +2. Click **Manage dbt Cloud**. 3. Add your dbt Cloud API key, and, optionally, a custom subdomain. Click **Save**. ### Model syncs diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index b58cd23568..d392f73c7b 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -2,14 +2,14 @@ title: Git Sync Extension --- -Segment's Git extension lets you manage versioning by syncing changes you make to Sources and Destinations from your Segment Workspace to a Git repository. +Segment's Git extension lets you manage versioning by syncing changes you make in Sources and Destinations from your Segment Workspace to a Git repository. > info "" -> Extensions, including Segment's dbt integration, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. +> Extensions, including Segment's Git sync integration, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. ## Set up Git sync -Follow these steps to connect set up Git sync: +Follow these steps to set up Git sync: 1. In your Segment Workspace, navigate to **Settings > Extensions**. 2. Click **Set up Git sync**. diff --git a/src/segment-app/extensions/index.md b/src/segment-app/extensions/index.md index fcd69746df..53f52dd19a 100644 --- a/src/segment-app/extensions/index.md +++ b/src/segment-app/extensions/index.md @@ -5,9 +5,9 @@ title: Extensions Extensions integrate third-party tools into your existing Segment Workspace to help you automate tasks. > info "" -> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. During Public Beta, Extensions is availability for Team and Developer plans only. [Reach out to Segment](mailto:friends@segment.com) if you're on a Business Tier plan and would like to participate in the Public Beta. +> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. During Public Beta, Extensions is available for Team and Developer plans only. [Reach out to Segment](mailto:friends@segment.com) if you're on a Business Tier plan and would like to participate in the Public Beta. During public beta, Segment offers the following extensions: -- [dbt models and dbt Cloud](/docs/segment-app/extensions/dbt), which let you sync models with dbt Labs -- [Git sync](/docs/segment-app/extensions/dbt), which you can use to manage versioning and track changes in your Segment Workspace +- [dbt models and dbt Cloud](/docs/segment-app/extensions/dbt), which lets you sync models with dbt Labs. +- [Git sync](/docs/segment-app/extensions/dbt), which you can use to manage versioning and track changes in your Segment Workspace. From 8d6c1a839015b7ee85cd41be9891c99a435fa8cb Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 16:55:11 -0500 Subject: [PATCH 07/12] Extensions, not integrations --- src/segment-app/extensions/dbt.md | 12 ++++++------ src/segment-app/extensions/git.md | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index 773e10b51f..3c050f92b2 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -2,9 +2,9 @@ title: dbt Extension --- -Segment's dbt integration lets you use [Reverse ETL](/docs/connections/reverse-etl/) with your existing dbt labs models and syncs to help centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes. +Segment's dbt extension lets you use [Reverse ETL](/docs/connections/reverse-etl/) with your existing dbt labs models and syncs to help centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes. -With Segment's dbt integration, you can: +With Segment's dbt extension, you can: - Securely connect Segment to the GitHub repository that stores your dbt models. - Use centralized dbt models to set up Reverse ETL. @@ -13,19 +13,19 @@ With Segment's dbt integration, you can: This page explains how to set up a dbt Model and then use the model with Reverse ETL. > info "" -> Extensions, including Segment's dbt integration, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. +> Extensions, including dbt sync, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. ## Before you begin -Keep the following in mind as you set up the dbt integration: +Keep the following in mind as you set up the dbt extension: -- The integration supports [dbt Core v1.7](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.7){:target="_blank"}. +- The extension supports [dbt Core v1.7](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.7){:target="_blank"}. - You can use Snowflake, Databricks, RedShift, Postgres, and BigQuery as Reverse ETL sources. - dbt models aren't synchronized from the dbt cloud. The model sync connects to a Git repository that loads models into Segment for use with Reverse ETL. ## Set up Git dbt Models and dbt Cloud -To set up the dbt integration, you'll need: +To set up the dbt extension, you'll need: - an existing dbt account with a Git repository - (for job syncs:) dbt cloud with jobs already created diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index d392f73c7b..4845aaa121 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -5,7 +5,7 @@ title: Git Sync Extension Segment's Git extension lets you manage versioning by syncing changes you make in Sources and Destinations from your Segment Workspace to a Git repository. > info "" -> Extensions, including Segment's Git sync integration, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. +> Extensions, including Git sync, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. ## Set up Git sync @@ -17,6 +17,6 @@ Follow these steps to set up Git sync: ## Working with Git syncs -After you set up the Git sync integration for the first time, Segment performs an initial sync that sends source and destination information in your Segment Workspace to the Git repository you connected. +After you set up the Git sync extension for the first time, Segment performs an initial sync that sends source and destination information in your Segment Workspace to the Git repository you connected. You can run syncs at any time by clicking **Full resync** on the Git sync page. To disable Git sync from the Git sync page, switch the **Enabled** toggle to off. \ No newline at end of file From 67efe184886ac8c753bbbbc4dc7e9af7eccdb6c5 Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 16:59:40 -0500 Subject: [PATCH 08/12] Add resource info --- src/segment-app/extensions/dbt.md | 2 +- src/segment-app/extensions/git.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index 3c050f92b2..d6cbe44969 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -36,7 +36,7 @@ Follow these steps to connect the Git repository that stores your dbt Models: 1. In your Segment Workspace, navigate to **Settings > Extensions**. 2. Click **Set up Git sync**. -3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key, then click **Next**. +3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key or GitHub token, then click **Next**. 4. In the **Connect source** window, select a Reverse ETL warehouse source from the dropdown, then click **Save**. After you've saved your setup, you can configure your Git repository's settings to your needs by changing the repository, branch, dbt version, default schema, and project path. diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index 4845aaa121..8422c34473 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -13,10 +13,12 @@ Follow these steps to set up Git sync: 1. In your Segment Workspace, navigate to **Settings > Extensions**. 2. Click **Set up Git sync**. -3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key, then click **Next**. +3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key or GitHub token, then click **Next**. ## Working with Git syncs +The Git sync extension syncs [Connections](/docs/connections/)([Sources](/docs/connections/sources/) and [Destinations](/docs/connections/destinations/)) from Segment to your Git repository. + After you set up the Git sync extension for the first time, Segment performs an initial sync that sends source and destination information in your Segment Workspace to the Git repository you connected. You can run syncs at any time by clicking **Full resync** on the Git sync page. To disable Git sync from the Git sync page, switch the **Enabled** toggle to off. \ No newline at end of file From 50b27d9980c60f0a9fa423bed6b2429b5bfa7605 Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 17:01:58 -0500 Subject: [PATCH 09/12] workspace not Workspace --- src/segment-app/extensions/dbt.md | 6 +++--- src/segment-app/extensions/git.md | 6 +++--- src/segment-app/extensions/index.md | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index d6cbe44969..c413a3559d 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -34,7 +34,7 @@ To set up the dbt extension, you'll need: Follow these steps to connect the Git repository that stores your dbt Models: -1. In your Segment Workspace, navigate to **Settings > Extensions**. +1. In your Segment workspace, navigate to **Settings > Extensions**. 2. Click **Set up Git sync**. 3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key or GitHub token, then click **Next**. 4. In the **Connect source** window, select a Reverse ETL warehouse source from the dropdown, then click **Save**. @@ -47,7 +47,7 @@ You can also use dbt Cloud to schedule Reverse ETL syncs after a dbt Cloud job s To set up dbt Cloud: -1. In your Segment Workspace, navigate to **Settings > Extensions**. +1. In your Segment workspace, navigate to **Settings > Extensions**. 2. Click **Manage dbt Cloud**. 3. Add your dbt Cloud API key, and, optionally, a custom subdomain. Click **Save**. @@ -59,7 +59,7 @@ After you set up dbt, Segment runs an initial sync to load models from your conn After you've successfully set up dbt with a warehouse and connected to your Git repository, you can select dbt models for use with Reverse ETL by following these steps: -1. In your Segment Workspace, navigate to **Connections > Sources** and select the Reverse ETL tab. +1. In your Segment workspace, navigate to **Connections > Sources** and select the Reverse ETL tab. 2. Click **+Add Reverse ETL source** , select your source, then click **Add Model**. 3. Click **dbt Models** as your modeling method, then select and preview a model from the dbt model dropdown. 4. Add a primary key, then click **Preview your model**. diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index 8422c34473..b17e5b7ff8 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -2,7 +2,7 @@ title: Git Sync Extension --- -Segment's Git extension lets you manage versioning by syncing changes you make in Sources and Destinations from your Segment Workspace to a Git repository. +Segment's Git extension lets you manage versioning by syncing changes you make in Sources and Destinations from your Segment workspace to a Git repository. > info "" > Extensions, including Git sync, is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. @@ -11,7 +11,7 @@ Segment's Git extension lets you manage versioning by syncing changes you make i Follow these steps to set up Git sync: -1. In your Segment Workspace, navigate to **Settings > Extensions**. +1. In your Segment workspace, navigate to **Settings > Extensions**. 2. Click **Set up Git sync**. 3. On the **Configure service credentials** page, select a service and protocol, add your SSH private key or GitHub token, then click **Next**. @@ -19,6 +19,6 @@ Follow these steps to set up Git sync: The Git sync extension syncs [Connections](/docs/connections/)([Sources](/docs/connections/sources/) and [Destinations](/docs/connections/destinations/)) from Segment to your Git repository. -After you set up the Git sync extension for the first time, Segment performs an initial sync that sends source and destination information in your Segment Workspace to the Git repository you connected. +After you set up the Git sync extension for the first time, Segment performs an initial sync that sends source and destination information in your Segment workspace to the Git repository you connected. You can run syncs at any time by clicking **Full resync** on the Git sync page. To disable Git sync from the Git sync page, switch the **Enabled** toggle to off. \ No newline at end of file diff --git a/src/segment-app/extensions/index.md b/src/segment-app/extensions/index.md index 53f52dd19a..471468a139 100644 --- a/src/segment-app/extensions/index.md +++ b/src/segment-app/extensions/index.md @@ -2,7 +2,7 @@ title: Extensions --- -Extensions integrate third-party tools into your existing Segment Workspace to help you automate tasks. +Extensions integrate third-party tools into your existing Segment workspace to help you automate tasks. > info "" > Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. During Public Beta, Extensions is available for Team and Developer plans only. [Reach out to Segment](mailto:friends@segment.com) if you're on a Business Tier plan and would like to participate in the Public Beta. @@ -10,4 +10,4 @@ Extensions integrate third-party tools into your existing Segment Workspace to h During public beta, Segment offers the following extensions: - [dbt models and dbt Cloud](/docs/segment-app/extensions/dbt), which lets you sync models with dbt Labs. -- [Git sync](/docs/segment-app/extensions/dbt), which you can use to manage versioning and track changes in your Segment Workspace. +- [Git sync](/docs/segment-app/extensions/dbt), which you can use to manage versioning and track changes in your Segment workspace. From 546a3af7e7d05d39b2e95bd74dd4a1ef216e2bde Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 17:05:18 -0500 Subject: [PATCH 10/12] Add to side navigation [netlify-build] --- src/_data/sidenav/main.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index a9a05d5230..5961af8377 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -596,6 +596,15 @@ sections: title: System for Cross-domain Identity Management (SCIM) Configuration Guide - path: /segment-app/iam/mfa title: Multi-Factor Authentication (MFA) + - section_title: Extensions + slug: segment-app/extensions + section: + - path: /segment-app/extensions + title: Extensions Overview + - path: /segment-app/extensions/dbt + title: dbt + - path: /segment-app/extensions/git + title: Git - path: /segment-app/iam/secure-password title: Picking a Secure Password - path: /segment-app/set-up-envs From c70a00193e3132767bfdc89734d2dbcfe3f5718b Mon Sep 17 00:00:00 2001 From: pwseg Date: Mon, 20 May 2024 17:31:48 -0500 Subject: [PATCH 11/12] small fixes --- src/segment-app/extensions/git.md | 2 +- src/segment-app/extensions/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index b17e5b7ff8..6955b88bd0 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -17,7 +17,7 @@ Follow these steps to set up Git sync: ## Working with Git syncs -The Git sync extension syncs [Connections](/docs/connections/)([Sources](/docs/connections/sources/) and [Destinations](/docs/connections/destinations/)) from Segment to your Git repository. +The Git sync extension syncs [Connections](/docs/connections/) ([Sources](/docs/connections/sources/) and [Destinations](/docs/connections/destinations/)) from Segment to your Git repository. After you set up the Git sync extension for the first time, Segment performs an initial sync that sends source and destination information in your Segment workspace to the Git repository you connected. diff --git a/src/segment-app/extensions/index.md b/src/segment-app/extensions/index.md index 471468a139..1948727b45 100644 --- a/src/segment-app/extensions/index.md +++ b/src/segment-app/extensions/index.md @@ -10,4 +10,4 @@ Extensions integrate third-party tools into your existing Segment workspace to h During public beta, Segment offers the following extensions: - [dbt models and dbt Cloud](/docs/segment-app/extensions/dbt), which lets you sync models with dbt Labs. -- [Git sync](/docs/segment-app/extensions/dbt), which you can use to manage versioning and track changes in your Segment workspace. +- [Git sync](/docs/segment-app/extensions/git), which you can use to manage versioning and track changes in your Segment workspace. From 5222ad5432e440e5d34ff9fff62f363e72222035 Mon Sep 17 00:00:00 2001 From: pwseg Date: Tue, 21 May 2024 12:38:28 -0500 Subject: [PATCH 12/12] Add Reverse ETL links --- src/segment-app/extensions/dbt.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index c413a3559d..079ea04db3 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -20,7 +20,7 @@ This page explains how to set up a dbt Model and then use the model with Reverse Keep the following in mind as you set up the dbt extension: - The extension supports [dbt Core v1.7](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.7){:target="_blank"}. -- You can use Snowflake, Databricks, RedShift, Postgres, and BigQuery as Reverse ETL sources. +- You can use [Snowflake](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/snowflake-setup/), [Databricks](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup/), [Redshift](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup/), [Postgres](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup/), and [BigQuery](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup/) as Reverse ETL sources. - dbt models aren't synchronized from the dbt cloud. The model sync connects to a Git repository that loads models into Segment for use with Reverse ETL. ## Set up Git dbt Models and dbt Cloud