-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation Standard Updates (#15)
* MagicBot/documentation-updates * Apply suggestions from code review
- Loading branch information
1 parent
d1846d1
commit 57bc8fd
Showing
7 changed files
with
84 additions
and
62 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 |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| name: 'auto release' | ||
| on: | ||
| pull_request: | ||
| types: | ||
| - closed | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| call-workflow-passing-data: | ||
| if: github.event.pull_request.merged | ||
| uses: fivetran/dbt_package_automations/.github/workflows/auto-release.yml@main | ||
| secrets: inherit |
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 |
|---|---|---|
|
|
@@ -12,29 +12,29 @@ | |
|
|
||
| # Pardot Source dbt Package ([Docs](https://fivetran.github.io/dbt_pardot_source/)) | ||
|
|
||
| # 📣 What does this dbt package do? | ||
| ## What does this dbt package do? | ||
| - Materializes [Pardot staging tables](https://fivetran.github.io/dbt_pardot_source/#!/overview/pardot_source/models/?g_v=1) which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/pardot/#schemainformation). These staging tables clean, test, and prepare your Pardot data from [Fivetran's connector](https://fivetran.com/docs/applications/pardot) for analysis by doing the following: | ||
| - Name columns for consistency across all packages and for easier analysis | ||
| - Adds freshness tests to source data | ||
| - Adds column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values. | ||
| - Generates a comprehensive data dictionary of your Pardot data through the [dbt docs site](https://fivetran.github.io/dbt_pardot_source/). | ||
| - These tables are designed to work simultaneously with our [Pardot transformation package](https://github.com/fivetran/dbt_pardot). | ||
|
|
||
| # 🎯 How do I use the dbt package? | ||
| ## Step 1: Prerequisites | ||
| ## How do I use the dbt package? | ||
| ### Step 1: Prerequisites | ||
| To use this dbt package, you must have the following: | ||
| - At least one Fivetran Pardot connector syncing data into your destination. | ||
| - At least one Fivetran Pardot connector syncing data into your destination. | ||
| - A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination. | ||
|
|
||
| ## Step 2: Install the package (skip if also using the `pardot` transformation package) | ||
| ### Step 2: Install the package (skip if also using the `pardot` transformation package) | ||
| If you are **not** using the [Pardot transformation package](https://github.com/fivetran/dbt_pardot), 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. | ||
| ```yaml | ||
| packages: | ||
| - package: fivetran/pardot_source | ||
| version: [">=0.6.0", "<0.7.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 `pardot` schema. If this is not where your Pardot data is (for example, if your Pardot schema is named `pardot_fivetran`), add the following configuration to your root `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
|
|
@@ -44,18 +44,18 @@ vars: | |
| pardot_schema: your_schema_name | ||
| ``` | ||
|
|
||
| ## (Optional) Step 4: Additional configurations | ||
| ### (Optional) Step 4: Additional configurations | ||
| <details><summary>Expand to view configurations</summary> | ||
|
|
||
| ### Changing the Build Schema | ||
| #### Changing the Build Schema | ||
| By default this package will build the Pardot staging models within a schema titled (<target_schema> + `_stg_pardot`). If this is not where you would like your Pardot staging models to be written to, add the following configuration to your `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
| models: | ||
| pardot_source: | ||
| +schema: my_new_staging_models_schema # leave blank for just the target_schema | ||
| ``` | ||
| ### Passthrough Columns | ||
| #### Passthrough Columns | ||
| By default, the package includes all of the standard columns in the `stg_pardot__prospect` model. If you want to include custom columns, configure them using the `prospect_passthrough_columns` variable: | ||
|
|
||
| ```yml | ||
|
|
@@ -64,7 +64,7 @@ vars: | |
| prospect_passthrough_columns: ["custom_creative","custom_contact_state"] | ||
| ``` | ||
|
|
||
| ### Change the source table references | ||
| #### Change the source table references | ||
| If an individual source table has a different name than 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_pardot_source/blob/main/dbt_project.yml) variable declarations to see the expected names. | ||
|
|
||
|
|
@@ -74,15 +74,15 @@ vars: | |
| ``` | ||
| </details> | ||
|
|
||
| ## (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™ | ||
| ### (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™ | ||
| <details><summary>Expand to view 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 | ||
|
|
@@ -94,16 +94,15 @@ packages: | |
| version: [">=1.0.0", "<2.0.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 that you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/pardot_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_pardot_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) to learn how to contribute to a dbt 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) to learn how to contribute to a dbt 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_pardot_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_pardot_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]. | ||