Skip to content

Commit 68d49af

Browse files
NoyaOfferNoyaOffer
committed
Migrate from <Snippet> syntax to Mintlify import syntax
- Convert all <Snippet file="..."> usage to ES6 import statements - Update 124 files across the documentation - Use PascalCase component names derived from filenames - Maintain absolute paths starting with /snippets/ - Preserve all existing content and functionality This migration aligns with Mintlify's recommended snippet syntax for better developer experience and standard React/JSX conventions.
1 parent af7d783 commit 68d49af

124 files changed

Lines changed: 744 additions & 204 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/_snippets/add-connection-profile.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import AllProfiles from '/snippets/profiles/all-profiles.mdx';
2+
13
## Configuring the Elementary Profile
24

35
In order to connect, Elementary needs a [connection profile](https://docs.getdbt.com/dbt-cli/configure-your-profile) in a file named `profiles.yml`.
@@ -40,4 +42,4 @@ Here is a demonstration:
4042
- Profile name: `elementary`
4143
- Schema name: The schema of elementary models, default is `<your_dbt_project_schema>_elementary`
4244

43-
<Snippet file="profiles/all-profiles.mdx" />
45+
<AllProfiles />

‎docs/_snippets/cli/bigquery-cli.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import CliServiceAccount from '/snippets/dwh/bigquery/cli_service_account.mdx';
2+
13
### BigQuery connection profile
24

35
After installing Elementary's dbt package upon running `dbt deps`,
@@ -38,7 +40,7 @@ elementary:
3840
We support the same format and connection methods as dbt. Please refer to dbt's documentation
3941
of [BigQuery](https://docs.getdbt.com/reference/warehouse-setups/bigquery-setup) for further details.
4042
41-
<Snippet file="dwh/bigquery/cli_service_account.mdx" />
43+
<CliServiceAccount />
4244
4345
Add the full path of this JSON file to your connection profile under 'keyfile'.
4446

‎docs/_snippets/cloud/integrations/athena.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
import CreateUserOperation from '/snippets/cloud/integrations/create-user-operation.mdx';
2+
13
You will connect Elementary Cloud to Athena for syncing the Elementary schema (created by the [Elementary dbt package](/cloud/onboarding/quickstart-dbt-package)).
24

3-
<Snippet file="cloud/integrations/create-user-operation.mdx" />
5+
<CreateUserOperation />
46

57
## AWS Setup
68

‎docs/_snippets/cloud/integrations/bigquery.mdx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
import CloudServiceAccount from '/snippets/dwh/bigquery/cloud_service_account.mdx';
2+
import PermissionsAndSecurity from '/snippets/cloud/integrations/permissions-and-security.mdx';
3+
import IpAllowlist from '/snippets/cloud/integrations/ip-allowlist.mdx';
4+
15
You will connect Elementary Cloud to Bigquery for syncing the Elementary schema (created by the [Elementary dbt package](/cloud/onboarding/quickstart-dbt-package)).
26

3-
<Snippet file="dwh/bigquery/cloud_service_account.mdx" />
7+
<CloudServiceAccount />
48

5-
<Snippet file="cloud/integrations/permissions-and-security.mdx" />
9+
<PermissionsAndSecurity />
610

711
### Fill the connection form
812

@@ -13,4 +17,4 @@ Provide the following fields:
1317
- **Elementary dataset**: The name of your Elementary dataset. Usually `[dataset name]_elementary`.
1418
- **Location**: Use this field to configure the location of BigQuery datasets as per [the BigQuery documentation](https://cloud.google.com/bigquery/docs/locations).
1519

16-
<Snippet file="cloud/integrations/ip-allowlist.mdx" />
20+
<IpAllowlist />

‎docs/_snippets/cloud/integrations/cards-groups/cloud-integrations-cards.mdx‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
1+
import ConnectDwhCards from '/snippets/cloud/integrations/cards-groups/connect-dwh-cards.mdx';
2+
import TransformationAndOrchestrationCards from '/snippets/cloud/integrations/cards-groups/transformation-and-orchestration-cards.mdx';
3+
import BiCards from '/snippets/cloud/integrations/cards-groups/bi-cards.mdx';
4+
import ReverseEtlCards from '/snippets/cloud/integrations/cards-groups/reverse-etl-cards.mdx';
5+
import CodeRepoCards from '/snippets/cloud/integrations/cards-groups/code-repo-cards.mdx';
6+
import AlertsDestinationCards from '/snippets/cloud/integrations/cards-groups/alerts-destination-cards.mdx';
7+
18
### Data warehouses
29

3-
<Snippet file="cloud/integrations/cards-groups/connect-dwh-cards.mdx" />
10+
<ConnectDwhCards />
411

512
### Transformation and orchestration
613

7-
<Snippet file="cloud/integrations/cards-groups/transformation-and-orchestration-cards.mdx" />
14+
<TransformationAndOrchestrationCards />
815

916
### Data visualization
1017

11-
<Snippet file="cloud/integrations/cards-groups/bi-cards.mdx" />
18+
<BiCards />
1219

1320
### Reverse ETL
1421

15-
<Snippet file="cloud/integrations/cards-groups/reverse-etl-cards.mdx" />
22+
<ReverseEtlCards />
1623

1724
### Code repositories
1825

19-
<Snippet file="cloud/integrations/cards-groups/code-repo-cards.mdx" />
26+
<CodeRepoCards />
2027

2128
### Alerts & incidents
2229

23-
<Snippet file="cloud/integrations/cards-groups/alerts-destination-cards.mdx" />
30+
<AlertsDestinationCards />

‎docs/_snippets/cloud/integrations/clickhouse.mdx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
import CreateUserOperation from '/snippets/cloud/integrations/create-user-operation.mdx';
2+
import IpAllowlist from '/snippets/cloud/integrations/ip-allowlist.mdx';
3+
14
You will connect Elementary Cloud to Clickhouse for syncing the Elementary schema (created by the [Elementary dbt package](/cloud/onboarding/quickstart-dbt-package)).
25

3-
<Snippet file="cloud/integrations/create-user-operation.mdx" />
6+
<CreateUserOperation />
47

58
### Fill the connection form
69

@@ -12,7 +15,7 @@ Provide the following fields:
1215
- **User**: The name of the for Elementary user.
1316
- **Password**: The password associated with the provided user.
1417

15-
<Snippet file="cloud/integrations/ip-allowlist.mdx" />
18+
<IpAllowlist />
1619

1720

1821
### Connect via SSH tunnel

‎docs/_snippets/cloud/integrations/create-user-operation-snowflake.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import PermissionsAndSecurity from '/snippets/cloud/integrations/permissions-and-security.mdx';
2+
13
### Create a user for Elementary cloud
24

35
* Please create a Snowflake key-pair (private and public key) using [this](https://docs.snowflake.com/en/user-guide/key-pair-auth#configuring-key-pair-authentication) guide.
@@ -14,4 +16,4 @@ dbt run-operation create_elementary_user --args "{'public_key': '$SNOWFLAKE_PUBL
1416

1517
This command will generate a query to create a user with the necessary permissions. Run this query on your data warehouse with **admin permissions** to create the user.
1618

17-
<Snippet file="cloud/integrations/permissions-and-security.mdx" />
19+
<PermissionsAndSecurity />

‎docs/_snippets/cloud/integrations/create-user-operation.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import PermissionsAndSecurity from '/snippets/cloud/integrations/permissions-and-security.mdx';
2+
13
### Create a user for Elementary cloud
24

35
On your dbt project, run:
@@ -9,4 +11,4 @@ dbt run-operation create_elementary_user
911

1012
This command will generate a query to create a user with the necessary permissions. Run this query on your data warehouse with **admin permissions** to create the user.
1113

12-
<Snippet file="cloud/integrations/permissions-and-security.mdx" />
14+
<PermissionsAndSecurity />

‎docs/_snippets/cloud/integrations/databricks.mdx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
import CreateServicePrincipal from '/snippets/dwh/databricks/create_service_principal.mdx';
2+
import PermissionsAndSecurity from '/snippets/cloud/integrations/permissions-and-security.mdx';
3+
import IpAllowlist from '/snippets/cloud/integrations/ip-allowlist.mdx';
4+
15
You will connect Elementary Cloud to Databricks for syncing the Elementary schema (created by the [Elementary dbt package](/cloud/onboarding/quickstart-dbt-package)).
26

3-
<Snippet file="dwh/databricks/create_service_principal.mdx" />
7+
<CreateServicePrincipal />
48

5-
<Snippet file="cloud/integrations/permissions-and-security.mdx" />
9+
<PermissionsAndSecurity />
610

711
### Fill the connection form
812

@@ -14,4 +18,4 @@ Provide the following fields:
1418
- **Catalog (optional)**: The name of the Databricks Catalog.
1519
- **Elementary schema**: The name of your Elementary schema. Usually `[schema name]_elementary`.
1620

17-
<Snippet file="cloud/integrations/ip-allowlist.mdx" />
21+
<IpAllowlist />

‎docs/_snippets/cloud/integrations/postgres.mdx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
import CreateUserOperation from '/snippets/cloud/integrations/create-user-operation.mdx';
2+
import IpAllowlist from '/snippets/cloud/integrations/ip-allowlist.mdx';
3+
14
You will connect Elementary Cloud to Postgres for syncing the Elementary schema (created by the [Elementary dbt package](/cloud/onboarding/quickstart-dbt-package)).
25

3-
<Snippet file="cloud/integrations/create-user-operation.mdx" />
6+
<CreateUserOperation />
47

58
### Fill the connection form
69

@@ -13,7 +16,7 @@ Provide the following fields:
1316
- **User**: The name of the for Elementary user.
1417
- **Password**: The password associated with the provided user.
1518

16-
<Snippet file="cloud/integrations/ip-allowlist.mdx" />
19+
<IpAllowlist />
1720

1821

1922
### Connect via SSH tunnel

0 commit comments

Comments
 (0)