diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 65a074b..4264c49 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,4 +1,7 @@
contact_links:
+ - name: Provide feedback to our dbt package team
+ url: https://www.surveymonkey.com/r/DQ7K7WW
+ about: Fill out our survey form to provide valuable feedback to the Fivetran team developing and maintaining the dbt packages.
- name: Ask a question during our office hours
url: https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours
about: Schedule time during the external office hours block with the Fivetran Analytics Engineering team for support
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5ee4f1b..36d601a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,4 +1,7 @@
# dbt_shopify_source v0.7.0
+## 🎉 Documentation and Feature Updates
+- Updated README documentation updates for easier navigation and setup of the dbt package
+- Included `shopify_[source_table_name]_identifier` variable for additional flexibility within the package when source tables are named differently.
## 🚨 Breaking Changes 🚨:
[PR #36](https://github.com/fivetran/dbt_shopify_source/pull/36) includes the following breaking changes:
diff --git a/README.md b/README.md
index d97d7ce..9770c9a 100644
--- a/README.md
+++ b/README.md
@@ -10,48 +10,73 @@
-# Shopify (Source)
-
-This package models Shopify data from [Fivetran's connector](https://fivetran.com/docs/applications/shopify). It uses data in the format described by [this ERD](https://fivetran.com/docs/applications/shopify#schemainformation).
-
-This package enriches your Fivetran data by doing the following:
-
-* Adds descriptions to tables and columns that are synced using Fivetran
-* Adds column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values.
-* Models staging tables, which will be used in our transform package
-
-## Models
-
-This package contains staging models, designed to work simultaneously with our [Shopify modeling package](https://github.com/fivetran/dbt_shopify). The staging models name columns consistently across all packages:
-* Boolean fields are prefixed with `is_` or `has_`
-* Timestamps are appended with `_at`
-* ID primary keys are prefixed with the name of the table. For example, the campaign table's ID column is renamed `campaign_id`.
-
-## Installation Instructions
-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.
-
-Include in your `packages.yml`
-
+# Shopify Source dbt Package ([Docs](https://fivetran.github.io/dbt_shopify_source/))
+# 📣 What does this dbt package do?
+- Materializes [Shopify staging tables](https://fivetran.github.io/dbt_shopify_source/#!/overview/github_source/models/?g_v=1) which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/shopify/#schemainformation). These staging tables clean, test, and prepare your Shopify data from [Fivetran's connector](https://fivetran.com/docs/applications/shopify) 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 Shopify data through the [dbt docs site](https://fivetran.github.io/dbt_shopify_source/).
+- These tables are designed to work simultaneously with our [Shopify transformation package](https://github.com/fivetran/dbt_shopify).
+
+# 🎯 How do I use the dbt package?
+## Step 1: Prerequisites
+To use this dbt package, you must have the following:
+- At least one Fivetran Shopify connector syncing data into your destination.
+- A **BigQuery**, **Snowflake**, **Redshift**, **Databricks**, or **PostgreSQL** destination.
+
+## Step 2: Install the package
+Include the following shopify_source package version in your `packages.yml` file.
+> 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/shopify_source
version: [">=0.7.0", "<0.8.0"]
```
+## Step 3: Define database and schema variables
+By default, this package runs using your destination and the `shopify` schema. If this is not where your Shopify data is (for example, if your Shopify schema is named `shopify_fivetran` and your `issue` table is named `usa_issue`), add the following configuration to your root `dbt_project.yml` file:
-## Configuration
-By default, this package looks for your Shopify data in the `shopify` 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 Shopify data is, add the following configuration to your `dbt_project.yml` file:
+```yml
+vars:
+ shopify_database: your_destination_name
+ shopify_schema: your_schema_name
+```
+
+## Step 4: Disabling models
+This package was designed with the intention that users have all relevant Shopify tables being synced by Fivetran. However, if you are a Shopify user that does not operate on returns or adjustments then you will not have the related source tables. As such, you may use the below variable configurations to disable the respective downstream models. All variables are `true` by default. To disable those models, add the below configuration in your root `dbt_project.yml` file:
```yml
# dbt_project.yml
...
-config-version: 2
-
vars:
- shopify_database: your_database_name
- shopify_schema: your_schema_name
+ shopify__using_order_adjustment: false # true by default
+ shopify__using_order_line_refund: false # true by default
+ shopify__using_refund: false # true by default
```
+## (Optional) Step 5: Additional configurations
+Expand to view configurations
+
+### Changing the Build Schema
+By default this package will build the Shopify staging models within a schema titled ( + `_stg_shopify`) in your target database. If this is not where you would like your staging Shopify data to be written to, add the following configuration to your `dbt_project.yml` file:
+
+```yml
+# dbt_project.yml
+
+...
+models:
+ shopify_source:
+ +schema: my_new_schema_name # leave blank for just the target_schema
+```
+### 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_shopify_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
+
+```yml
+vars:
+ shopify__identifier: your_table_name
+```
### Union Multiple Shopify Connectors
If you have multiple Shopify connectors in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. The package will union all of the data together and pass the unioned table into the transformations. You will be able to see which source it came from in the `source_relation` column of each model. To use this functionality, you will need to set either the `shopify_union_schemas` or `shopify_union_databases` variables:
@@ -65,7 +90,6 @@ vars:
shopify_union_schemas: ['shopify_usa','shopify_canada'] # use this if the data is in different schemas/datasets of the same database/project
shopify_union_databases: ['shopify_usa','shopify_canada'] # use this if the data is in different databases/projects but uses the same schema name
```
-
### Add Passthrough Columns
This package includes all source columns defined in the staging_columns.sql macro. To add additional columns to this package, do so using our pass-through column variables. This is extremely useful if you'd like to include custom fields to the package.
@@ -85,60 +109,38 @@ vars:
product_variant_pass_through_columns: []
```
-### Disable Models
-This package was designed with the intention that users have all relevant Shopify tables being synced by Fivetran. However, if you are a Shopify user that does not operate on returns or adjustments then you will not have the related source tables. As such, you may use the below variable configurations to disable the respective downstream models. All variables are `true` by default. Only add the below configuration if you are wishing to disable the models:
-
-```yml
-# dbt_project.yml
-
-...
-vars:
- shopify__using_order_adjustment: false # true by default
- shopify__using_order_line_refund: false # true by default
- shopify__using_refund: false # true by default
-```
-### Changing the Build Schema
-By default this package will build the Shopify staging models within a schema titled ( + `_stg_shopify`) in your target database. If this is not where you would like your staging Shopify data to be written to, add the following configuration to your `dbt_project.yml` file:
+Expand to view details
+
+
+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).
+