-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37 from fivetran/MagicBot/documentation-updates
Documentation Standard Updates
- Loading branch information
Showing
6 changed files
with
62 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,7 @@ | |
| </p> | ||
|
|
||
| # Marketo Source dbt Package ([docs](https://fivetran.github.io/dbt_market_source/)) | ||
| # 📣 What does this dbt package do? | ||
| ## What does this dbt package do? | ||
|
|
||
| - Produces staging tables that leverage Marketo data from [Fivetran's connector](https://fivetran.com/docs/applications/marketo) in the format described by [this ERD](https://fivetran.com/docs/applications/marketo#schema). | ||
| - Adds descriptions to tables and columns that are synced using Fivetran | ||
|
|
@@ -20,23 +20,23 @@ | |
| - Generates a comprehensive data dictionary of your source and modeled Marketo data through the [dbt docs site](https://fivetran.github.io/dbt_marketo_source/). | ||
| - These tables are designed to work simultaneously with our [Marketo transformation package](https://github.com/fivetran/dbt_marketo/). | ||
|
|
||
| # 🎯 How do I use the dbt package? | ||
| ## How do I use the dbt package? | ||
|
|
||
| ## Step 1: Prerequisites | ||
| ### Step 1: Prerequisites | ||
| To use this dbt package, you must have the following: | ||
|
|
||
| - At least one Fivetran Marketo connector syncing data into your destination. | ||
| - A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination. | ||
|
|
||
| ### Databricks Dispatch Configuration | ||
| #### Databricks Dispatch Configuration | ||
| If you are using a Databricks destination with this package you will need to add the below (or a variation of the below) dispatch configuration within your `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively. | ||
| ```yml | ||
| dispatch: | ||
| - macro_namespace: dbt_utils | ||
| search_order: ['spark_utils', 'dbt_utils'] | ||
| ``` | ||
| ## Step 2: Install the package (skip if also using the `Marketo` transformation package) | ||
| ### Step 2: Install the package (skip if also using the `Marketo` transformation package) | ||
| If you are **not** using the [Marketo transformation package](https://github.com/fivetran/dbt_marketo), include the following package version in your `packages.yml` file. If you are installing the transform package, the source package is automatically installed as a dependency. | ||
| > TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages. | ||
|
|
||
|
|
@@ -46,7 +46,7 @@ packages: | |
| version: [">=0.11.0", "<0.12.0"] | ||
| ``` | ||
|
|
||
| ## Step 3: Define database and schema variables | ||
| ### Step 3: Define database and schema variables | ||
| By default, this package runs using your destination and the `marketo` schema of your [target database](https://docs.getdbt.com/docs/running-a-dbt-project/using-the-command-line-interface/configure-your-profile). If this is not where your Marketo data is (for example, if your Marketo schema is named `marketo_fivetran`), add the following configuration to your root `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
|
|
@@ -55,7 +55,7 @@ vars: | |
| marketo_schema: your_schema_name | ||
| ``` | ||
|
|
||
| ## Step 4: Enabling/Disabling Models | ||
| ### Step 4: Enabling/Disabling Models | ||
| This package takes into consideration tables that may not be synced due to slowness caused by the Marketo API. By default the `campaign` and `program` models are disabled. If you sync these tables, enable the modeling done by adding the following to your `dbt_project.yml` file: | ||
| ```yml | ||
| vars: | ||
|
|
@@ -69,11 +69,11 @@ vars: | |
| marketo__activity_delete_lead_enabled: false # Disable if you do not have the activity_delete_lead table | ||
| ``` | ||
|
|
||
| ## (Optional) Step 5: Additional configurations | ||
| ### (Optional) Step 5: Additional configurations | ||
| <details><summary>Expand for details</summary> | ||
| <br> | ||
|
|
||
| ### Passing Through Additional Columns | ||
| #### Passing Through Additional Columns | ||
| This package includes all source columns defined in the macros folder. If you would like to pass through additional columns to the staging models, add the following configurations to your `dbt_project.yml` file. These variables allow for the pass-through fields to be aliased (`alias`) and casted (`transform_sql`) if desired, but not required. Datatype casting is configured via a sql snippet within the `transform_sql` key. You may add the desired sql while omitting the `as field_name` at the end and your custom pass-though fields will be casted accordingly. Use the below format for declaring the respective pass-through variables in your root `dbt_project.yml`. | ||
| ```yml | ||
| vars: | ||
|
|
@@ -87,15 +87,15 @@ vars: | |
| marketo__program_passthrough_columns: | ||
| ``` | ||
|
|
||
| ### Changing the Build Schema | ||
| #### Changing the Build Schema | ||
| By default this package will build the Marketo staging models within a schema titled (<target_schema> + `_marketo_source`) in your target database. If this is not where you would like your Marketo data to be written to, add the following configuration to your `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
| models: | ||
| marketo_source: | ||
| +schema: my_new_schema_name # leave blank for just the target_schema | ||
| ``` | ||
| ### Change the source table references | ||
| #### Change the source table references | ||
| If an individual source table has a different name than what the package expects, add the table name as it appears in your destination to the respective variable: | ||
| > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_marketo_source/blob/main/dbt_project.yml) variable declarations to see the expected names. | ||
|
|
||
|
|
@@ -105,15 +105,15 @@ vars: | |
| ``` | ||
| </details> | ||
|
|
||
| ## (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™ | ||
| ### (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™ | ||
| <details><summary>Expand for details</summary> | ||
| <br> | ||
|
|
||
| Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core setup guides](https://fivetran.com/docs/transformations/dbt#setupguide). | ||
| </details> | ||
|
|
||
| # 🔍 Does this package have dependencies? | ||
| This dbt package is dependent on the following dbt packages. Please be aware that these dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site. | ||
| ## Does this package have dependencies? | ||
| This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site. | ||
| > IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts. | ||
|
|
||
| ```yml | ||
|
|
@@ -128,16 +128,15 @@ packages: | |
| version: [">=0.3.0", "<0.4.0"] | ||
| ``` | ||
|
|
||
| # 🙌 How is this package maintained and can I contribute? | ||
| ## Package Maintenance | ||
| ## How is this package maintained and can I contribute? | ||
| ### Package Maintenance | ||
| The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/marketo/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_marketo_source/blob/main/CHANGELOG.md) and release notes for more information on changes across versions. | ||
|
|
||
| ## Contributions | ||
| A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions! | ||
| ### Contributions | ||
| A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions. | ||
|
|
||
| We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package! | ||
| We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package. | ||
|
|
||
| # 🏪 Are there any resources available? | ||
| - If you have questions or want to reach out for help, please refer to the [GitHub Issue](https://github.com/fivetran/dbt_marketo_source/issues/new/choose) section to find the right avenue of support for you. | ||
| ## Are there any resources available? | ||
| - If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_marketo_source/issues/new/choose) section to find the right avenue of support for you. | ||
| - If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW). | ||
| - Have questions or want to just say hi? Book a time during our office hours [on Calendly](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) or email us at [email protected]. | ||