update snippet prop name

alex-mirkin · Jul 5, 2023 · a05e0d7 · a05e0d7
1 parent dd52e92
commit a05e0d7
Show file tree

Hide file tree

Showing 56 changed files with 118 additions and 118 deletions.
diff --git a/contributing/single-sourcing-content.md b/contributing/single-sourcing-content.md
@@ -226,7 +226,7 @@ The Snippet component allows for content to be reusable throughout the Docs. Thi
 Creating and using a snippet requires two steps:
 
 1. Create a new markdown snippet file in the `website/snippets` directory.
-2. Use the `<Snippet src="filename" />` component within a Docs file.
+2. Use the `<Snippet path="filename" />` component within a Docs file.
 
 ### Snippet properties
 
@@ -247,7 +247,7 @@ Now, we can add this snippet to a Docs file with the Snippet component:
 ```markdown
 Docs content here.
 
-<Snippet src="lorem-ipsum" />
+<Snippet path="lorem-ipsum" />
 
 Docs content here.
 ```
diff --git a/website/docs/docs/build/hooks-operations.md b/website/docs/docs/build/hooks-operations.md
@@ -38,7 +38,7 @@ Hooks are snippets of SQL that are executed at different times:
 
 Hooks are a more-advanced capability that enable you to run custom SQL, and leverage database-specific actions, beyond what dbt makes available out-of-the-box with standard materializations and configurations.
 
-<Snippet src="hooks-to-grants" />
+<Snippet path="hooks-to-grants" />
 
 <VersionBlock firstVersion="1.2">
 

diff --git a/website/docs/docs/build/incremental-models.md b/website/docs/docs/build/incremental-models.md
@@ -456,5 +456,5 @@ The syntax depends on how you configure your `incremental_strategy`:
 
 </VersionBlock>
 
-<Snippet src="discourse-help-feed-header" />
+<Snippet path="discourse-help-feed-header" />
 <DiscourseHelpFeed tags="incremental"/>
diff --git a/website/docs/docs/build/jinja-macros.md b/website/docs/docs/build/jinja-macros.md
@@ -185,5 +185,5 @@ Writing a macro for the first time? Check whether we've open sourced one in [dbt
 {% endfor %}
 ```
 
-<Snippet src="discourse-help-feed-header" />
+<Snippet path="discourse-help-feed-header" />
 <DiscourseHelpFeed tags="wee"/>
diff --git a/website/docs/docs/build/materializations.md b/website/docs/docs/build/materializations.md
@@ -179,6 +179,6 @@ def model(dbt, session):
 
 **Note:** Incremental models are supported on BigQuery/Dataproc for the `merge` incremental strategy. The `insert_overwrite` strategy is not yet supported.
 
-<Snippet src="discourse-help-feed-header" />
+<Snippet path="discourse-help-feed-header" />
 <DiscourseHelpFeed tags="materialization"/>
 
diff --git a/website/docs/docs/build/metrics.md b/website/docs/docs/build/metrics.md
@@ -714,5 +714,5 @@ The above example will return a dataset that contains the metric provided in the
 
 </VersionBlock>
 
-<Snippet src="discourse-help-feed-header" />
+<Snippet path="discourse-help-feed-header" />
 <DiscourseHelpFeed tags="metrics"/>
diff --git a/website/docs/docs/build/project-variables.md b/website/docs/docs/build/project-variables.md
@@ -120,5 +120,5 @@ If dbt is unable to find a definition for a variable after checking these four p
 
 **Note:** Variable scope is based on the node ultimately using that variable. Imagine the case where a model defined in the root project is calling a macro defined in an installed package. That macro, in turn, uses the value of a variable. The variable will be resolved based on the _root project's_ scope, rather than the package's scope.
 
-<Snippet src="discourse-help-feed-header" />
+<Snippet path="discourse-help-feed-header" />
 <DiscourseHelpFeed tags="variables"/>
diff --git a/website/docs/docs/cloud/about-cloud/tenancy.md b/website/docs/docs/cloud/about-cloud/tenancy.md
@@ -24,4 +24,4 @@ _To learn more about setting up a dbt Cloud single tenant deployment, [please co
 
 ### Available features
 
-<Snippet src="cloud-feature-parity" />
+<Snippet path="cloud-feature-parity" />
diff --git a/website/docs/docs/cloud/connect-data-platform/connect-apache-spark.md b/website/docs/docs/cloud/connect-data-platform/connect-apache-spark.md
@@ -5,7 +5,7 @@ description: "Setup instructions for connecting Apache Spark to dbt Cloud"
 sidebar_label: "Connect Apache Spark"
 ---
 
-<Snippet src="dbt-databricks-for-databricks" />
+<Snippet path="dbt-databricks-for-databricks" />
 
 :::note
 See [Connect Databricks](#connect-databricks) for the Databricks version of this page.

diff --git a/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md b/website/docs/docs/cloud/connect-data-platform/connect-snowflake.md
@@ -9,7 +9,7 @@ The following fields are required when creating a Snowflake connection
 
 | Field | Description | Examples |
 | ----- | ----------- | -------- |
-| Account | The Snowflake account to connect to. Take a look [here](/docs/core/connect-data-platform/snowflake-setup#account) to determine what the account field should look like based on your region.| <Snippet src="snowflake-acct-name" /> |
+| Account | The Snowflake account to connect to. Take a look [here](/docs/core/connect-data-platform/snowflake-setup#account) to determine what the account field should look like based on your region.| <Snippet path="snowflake-acct-name" /> |
 | Role | A mandatory field indicating what role should be assumed after connecting to Snowflake | `transformer` |
 | Database | The logical database to connect to and run queries against. | `analytics` |
 | Warehouse | The virtual warehouse to use for running queries. | `transforming` |

diff --git a/website/docs/docs/cloud/connect-data-platform/connect-starburst-trino.md b/website/docs/docs/cloud/connect-data-platform/connect-starburst-trino.md
@@ -17,11 +17,11 @@ The following are the required fields for setting up a connection with a [Starbu
 
 ## Roles in Starburst Enterprise
 
-<Snippet src="connect-starburst-trino/roles-starburst-enterprise" />
+<Snippet path="connect-starburst-trino/roles-starburst-enterprise" />
 
 ## Catalogs and schemas
 
-<Snippet src="connect-starburst-trino/schema-db-fields" />
+<Snippet path="connect-starburst-trino/schema-db-fields" />
 
 ## Configuration
 

diff --git a/website/docs/docs/cloud/git/connect-azure-devops.md b/website/docs/docs/cloud/git/connect-azure-devops.md
@@ -3,7 +3,7 @@ title: "Connect to Azure DevOps"
 id: "connect-azure-devops"
 ---
 
-<Snippet src="available-enterprise-tier-only" />
+<Snippet path="available-enterprise-tier-only" />
 
 
 ## About Azure DevOps and dbt Cloud

diff --git a/website/docs/docs/cloud/git/setup-azure.md b/website/docs/docs/cloud/git/setup-azure.md
@@ -5,7 +5,7 @@ description: "You can set up your Azure DevOps by creating an Azure AD app and a
 sidebar_label: "Set up Azure DevOps"
 ---
 
-<Snippet src="available-enterprise-tier-only" />
+<Snippet path="available-enterprise-tier-only" />
 
 ## Overview
 

diff --git a/website/docs/docs/cloud/manage-access/auth0-migration.md b/website/docs/docs/cloud/manage-access/auth0-migration.md
@@ -16,7 +16,7 @@ If you have not yet configured SSO in dbt Cloud, refer instead to our setup guid
 
 ## Auth0 Multi-tenant URIs
 
-<Snippet src="auth0-uri" />
+<Snippet path="auth0-uri" />
 
 ## Start the migration
 

diff --git a/website/docs/docs/cloud/manage-access/set-up-sso-azure-active-directory.md b/website/docs/docs/cloud/manage-access/set-up-sso-azure-active-directory.md
@@ -156,7 +156,7 @@ To complete setup, follow the steps below in the dbt Cloud application.
     here, you can navigate to the login URL generated for your account's _slug_ to
     test logging in with Azure AD.
 
-<Snippet src="login_url_note" />
+<Snippet path="login_url_note" />
 
 
 

diff --git a/website/docs/docs/cloud/manage-access/set-up-sso-google-workspace.md b/website/docs/docs/cloud/manage-access/set-up-sso-google-workspace.md
@@ -113,7 +113,7 @@ Settings.
 
 If the verification information looks appropriate, then you have completed the configuration of GSuite SSO. 
 
-<Snippet src="login_url_note" />
+<Snippet path="login_url_note" />
 
 ## Setting up RBAC
 Now you have completed setting up SSO with GSuite, the next steps will be to set up

diff --git a/website/docs/docs/cloud/manage-access/set-up-sso-okta.md b/website/docs/docs/cloud/manage-access/set-up-sso-okta.md
@@ -72,7 +72,7 @@ dashes. It should contain only letters, numbers, and dashes. For example, the _l
 `dbt-labs`. Login slugs must be unique across all dbt Cloud accounts,
 so pick a slug that uniquely identifies your company.
 
-<Snippet src="access_url" />
+<Snippet path="access_url" />
 
 * **Single sign on URL**: `https://YOUR_AUTH0_URI/login/callback?connection=<login slug>`
 * **Audience URI (SP Entity ID)**: `urn:auth0:<YOUR_AUTH0_ENTITYID>:{login slug}`
@@ -187,7 +187,7 @@ configured in the steps above.
     test logging in with Okta. Additionally, users added the the Okta app
     will be able to log in to dbt Cloud from Okta directly.
 
-<Snippet src="login_url_note" />
+<Snippet path="login_url_note" />
 
 
 ## Setting up RBAC

diff --git a/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md b/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md
@@ -18,7 +18,7 @@ provider in order to configure Single Sign On and [role-based access control](/d
 
 ## Auth0 Multi-tenant URIs
 
-<Snippet src="auth0-uri" />
+<Snippet path="auth0-uri" />
 
 ## Generic SAML 2.0 integrations
 
@@ -39,7 +39,7 @@ You'll need administrator access to your SAML 2.0 compliant identity provider to
 
 #### Configuring the application
 
-<Snippet src="access_url" />
+<Snippet path="access_url" />
 
 To complete this section, you will need to create a login slug. This slug controls the URL where users on your account can log into your application. Login slugs are typically the lowercased name of your organization. It should contain only letters, numbers, and dashes.
 separated with dashes. For example, the login slug for dbt Labs would be `dbt-labs`.
@@ -117,7 +117,7 @@ You can use the instructions in this section to configure Okta as your identity
 
 ### Configure the Okta application
 
-<Snippet src="access_url" />
+<Snippet path="access_url" />
 
 To complete this section, you will need to create a login slug. This slug controls the URL where users on your account can log into your application. Login slugs are typically the lowercased name of your organization. It should contain only letters, numbers, and dashes.
 separated with dashes. For example, the login slug for dbt Labs would be `dbt-labs`.
@@ -220,7 +220,7 @@ Use this section if you are configuring Google as your identity provider.
 
 ### Configure the Google application
 
-<Snippet src="access_url" />
+<Snippet path="access_url" />
 
 To complete this section, you will need to create a login slug. This slug controls the URL where users on your account
 can log into your application. Login slugs are typically the lowercased name of your organization
@@ -288,7 +288,7 @@ If you're using Azure Active Directory (Azure AD), the instructions below will h
 
 ### Create Azure AD Enterprise application
 
-<Snippet src="access_url" />
+<Snippet path="access_url" />
 
 To complete this section, you will need to create a login slug. This slug controls the URL where users on your account can log into your application. Login slugs are typically the lowercased name of your organization
 separated with dashes. It should contain only letters, numbers, and dashes. For example, the login slug for dbt Labs would be `dbt-labs`.
@@ -352,7 +352,7 @@ To configure OneLogin, you will need **Administrator** access.
 
 ### Configure the OneLogin application
 
-<Snippet src="access_url" />
+<Snippet path="access_url" />
 
 To complete this section, you will need to create a login slug. This slug controls the URL where users on your account can log into your application. Login slugs are typically the lowercased name of your organization
 separated with dashes. It should contain only letters, numbers, and dashes. For example, the login slug for dbt Labs would be `dbt-labs`.
@@ -432,7 +432,7 @@ To complete setup, follow the steps below in dbt Cloud:
 5. After completing the setup, you can navigate to the URL generated for your account's _slug_ to test logging in with your identity provider. Additionally, users added the the SAML 2.0 app will be able to log in to dbt Cloud from the IdP directly.
 
 
-<Snippet src="login_url_note" />
+<Snippet path="login_url_note" />
 
 ### Setting up RBAC
 

diff --git a/website/docs/docs/cloud/manage-access/sso-overview.md b/website/docs/docs/cloud/manage-access/sso-overview.md
@@ -17,7 +17,7 @@ Once you configure SSO, even partially, you cannot disable or revert it. When yo
 
 ## Auth0 Multi-tenant URIs
 
-<Snippet src="auth0-uri" />
+<Snippet path="auth0-uri" />
 
 ## SSO process
 

diff --git a/website/docs/docs/core/connect-data-platform/bigquery-setup.md b/website/docs/docs/core/connect-data-platform/bigquery-setup.md
@@ -16,7 +16,7 @@ meta:
 ---
 
 
-<Snippet src="warehouse-setups-cloud-callout" />
+<Snippet path="warehouse-setups-cloud-callout" />
 
 <h2> Overview of {frontMatter.meta.pypi_package} </h2>
 

diff --git a/website/docs/docs/core/connect-data-platform/databricks-setup.md b/website/docs/docs/core/connect-data-platform/databricks-setup.md
@@ -16,7 +16,7 @@ meta:
   config_page: '/reference/resource-configs/databricks-configs'
 --- 
 
-<Snippet src="warehouse-setups-cloud-callout" />
+<Snippet path="warehouse-setups-cloud-callout" />
 
 <h2> Overview of {frontMatter.meta.pypi_package} </h2>
 

diff --git a/website/docs/docs/core/connect-data-platform/postgres-setup.md b/website/docs/docs/core/connect-data-platform/postgres-setup.md
@@ -16,7 +16,7 @@ meta:
   config_page: '/reference/resource-configs/postgres-configs'
 ---
 
-<Snippet src="warehouse-setups-cloud-callout" />
+<Snippet path="warehouse-setups-cloud-callout" />
 
 <h2> Overview of {frontMatter.meta.pypi_package} </h2>
 

diff --git a/website/docs/docs/core/connect-data-platform/redshift-setup.md b/website/docs/docs/core/connect-data-platform/redshift-setup.md
@@ -16,7 +16,7 @@ meta:
   config_page: '/reference/resource-configs/redshift-configs'
 ---
 
-<Snippet src="warehouse-setups-cloud-callout" />
+<Snippet path="warehouse-setups-cloud-callout" />
 
 <h2> Overview of {frontMatter.meta.pypi_package} </h2>
 

diff --git a/website/docs/docs/core/connect-data-platform/snowflake-setup.md b/website/docs/docs/core/connect-data-platform/snowflake-setup.md
@@ -16,7 +16,7 @@ meta:
   config_page: '/reference/resource-configs/snowflake-configs'
 ---
 
-<Snippet src="warehouse-setups-cloud-callout" />
+<Snippet path="warehouse-setups-cloud-callout" />
 
 <h2> Overview of {frontMatter.meta.pypi_package} </h2>
 

diff --git a/website/docs/docs/core/connect-data-platform/spark-setup.md b/website/docs/docs/core/connect-data-platform/spark-setup.md
@@ -17,8 +17,8 @@ meta:
 ---
 
 
-<Snippet src="warehouse-setups-cloud-callout" />
-<Snippet src="dbt-databricks-for-databricks" />
+<Snippet path="warehouse-setups-cloud-callout" />
+<Snippet path="dbt-databricks-for-databricks" />
 
 :::note
 See [Databricks setup](#databricks-setup) for the Databricks version of this page.

diff --git a/website/docs/docs/core/connect-data-platform/trino-setup.md b/website/docs/docs/core/connect-data-platform/trino-setup.md
@@ -16,7 +16,7 @@ meta:
   config_page: '/reference/resource-configs/trino-configs'
 ---
 
-<Snippet src="warehouse-setups-cloud-callout" />
+<Snippet path="warehouse-setups-cloud-callout" />
 
 <h2> Overview of {frontMatter.meta.pypi_package} </h2>
 
@@ -70,10 +70,10 @@ The following profile fields are always required except for `user`, which is als
 |   `user`   | Format for Starburst Enterprise or Trino: <br/> <ul><li>`user.name`</li><li>`[email protected]`</li></ul><br/>Format for Starburst Galaxy:<br/> <ul><li>`[email protected]/role`</li></ul> | The username (of the account) to log in to your cluster. When connecting to Starburst Galaxy clusters, you must include the role of the user as a suffix to the username. |
 
 ### Roles in Starburst Enterprise
-<Snippet src="connect-starburst-trino/roles-starburst-enterprise" />
+<Snippet path="connect-starburst-trino/roles-starburst-enterprise" />
 
 ### Schemas and databases
-<Snippet src="connect-starburst-trino/schema-db-fields" />
+<Snippet path="connect-starburst-trino/schema-db-fields" />
 
 ## Additional parameters
 

diff --git a/website/docs/docs/dbt-cloud-apis/discovery-querying.md b/website/docs/docs/dbt-cloud-apis/discovery-querying.md
@@ -10,7 +10,7 @@ Use the Discovery API to evaluate data pipeline health and project state across
 
 Since GraphQL provides a description of the data in the API, the schema displayed in the GraphQL explorer accurately represents the graph and fields available to query.  
 
-<Snippet src="metadata-api-prerequisites" />
+<Snippet path="metadata-api-prerequisites" />
 
 ## Authorization
 

diff --git a/website/docs/docs/dbt-cloud-apis/schema-discovery-environment.mdx b/website/docs/docs/dbt-cloud-apis/schema-discovery-environment.mdx
@@ -6,7 +6,7 @@ id: "discovery-schema-environment"
 
 import { ArgsTable, SchemaTable } from "./schema";
 
-<Snippet src="discovery-public-preview-banner" />
+<Snippet path="discovery-public-preview-banner" />
 
 This environment object allows you to query information about a particular model based on `environmentId`.
 

diff --git a/website/docs/docs/dbt-cloud-apis/schema-discovery-modelByEnv.mdx b/website/docs/docs/dbt-cloud-apis/schema-discovery-modelByEnv.mdx
@@ -6,7 +6,7 @@ id: "discovery-schema-modelByEnv"
 
 import { ArgsTable, SchemaTable } from "./schema";
 
-<Snippet src="discovery-public-preview-banner" />
+<Snippet path="discovery-public-preview-banner" />
 
 This model by environment object allows you to query information about a particular model based on `environmentId`.
 

diff --git a/website/docs/docs/dbt-versions/core-versions.md b/website/docs/docs/dbt-versions/core-versions.md
@@ -8,10 +8,10 @@ dbt Core releases follow [semantic versioning](https://semver.org/) guidelines.
 
 dbt Labs provides different support levels for different versions, which may include new features, bug fixes, or security patches:
 
-<Snippet src="core-version-support" />
+<Snippet path="core-version-support" />
 
 
-<Snippet src="core-versions-table" />
+<Snippet path="core-versions-table" />
 
 ### Further reading
 

diff --git a/website/docs/docs/dbt-versions/upgrade-core-in-cloud.md b/website/docs/docs/dbt-versions/upgrade-core-in-cloud.md
@@ -29,11 +29,11 @@ dbt Labs has always encouraged users to upgrade dbt Core versions whenever a new
 
 We provide different support levels for different versions, which may include new features, bug fixes, or security patches:
 
-<Snippet src="core-version-support" />
+<Snippet path="core-version-support" />
 
 We'll continue to update the following release table so that users know when we plan to stop supporting different versions of Core in dbt Cloud.
 
-<Snippet src="core-versions-table" />
+<Snippet path="core-versions-table" />
 
 Starting with v1.0, dbt Cloud will ensure that you're always using the latest compatible patch release of `dbt-core` and plugins, including all the latest fixes. You may also choose to try prereleases of those patch releases before they are generally available.
 

diff --git a/website/docs/docs/deploy/job-notifications.md b/website/docs/docs/deploy/job-notifications.md
@@ -22,4 +22,4 @@ There are two options for setting up email notifications. As a **user**, you can
 
 ### Slack
 
-<Snippet src="slack-notifications-config-steps" />
+<Snippet path="slack-notifications-config-steps" />
diff --git a/website/docs/docs/introduction.md b/website/docs/docs/introduction.md
@@ -3,7 +3,7 @@ title: "What is dbt?"
 id: "introduction"
 ---
 
-<Snippet src="what-is-dbt-intro" />
+<Snippet path="what-is-dbt-intro" />
 
 dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. This single source of truth, combined with the ability to define tests for your data, reduces errors when logic changes, and alerts you when issues arise.
 

diff --git a/website/docs/docs/use-dbt-semantic-layer/dbt-semantic-layer.md b/website/docs/docs/use-dbt-semantic-layer/dbt-semantic-layer.md
@@ -35,9 +35,9 @@ The dbt Semantic Layer reduces code duplication and inconsistency regarding your
 ## Prerequisites
 To use the dbt Semantic Layer, you’ll need to meet the following:
 
-<Snippet src="sl-prerequisites" />
+<Snippet path="sl-prerequisites" />
 
-<Snippet src="sl-considerations-banner" />
+<Snippet path="sl-considerations-banner" />
 
 ## Public Preview
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,4 @@ _To learn more about setting up a dbt Cloud single tenant deployment, [please co

		### Available features

		<Snippet src="cloud-feature-parity" />
		<Snippet path="cloud-feature-parity" />
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,7 +16,7 @@ meta: @@
     ---
-    <Snippet src="warehouse-setups-cloud-callout" />
+    <Snippet path="warehouse-setups-cloud-callout" />
     <h2> Overview of {frontMatter.meta.pypi_package} </h2>
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,4 +22,4 @@ There are two options for setting up email notifications. As a user, you can

		### Slack

		<Snippet src="slack-notifications-config-steps" />
		<Snippet path="slack-notifications-config-steps" />