From f6fadf41cb9e5d222246a9ce9593ac82d30ae10a Mon Sep 17 00:00:00 2001 From: Maayan-s Date: Wed, 30 Oct 2024 09:32:45 +0200 Subject: [PATCH 1/7] oss introduction --- docs/_snippets/oss/oss-introduction.mdx | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/_snippets/oss/oss-introduction.mdx b/docs/_snippets/oss/oss-introduction.mdx index ae893786b..54ad4ce4d 100644 --- a/docs/_snippets/oss/oss-introduction.mdx +++ b/docs/_snippets/oss/oss-introduction.mdx @@ -1,3 +1,18 @@ + + +Elementary OSS is a CLI tool you can deploy with the [Elementary dbt package](/guides/modules-overview/dbt-package) and orchestrate to send Slack alerts and self-host the Elementary report. + +To gain the most value from Elementary, we recommend using the [Elementary Cloud Platform](/cloud/introduction). + +### Elementary OSS vs Elementary Cloud Platform + +- **Elementary Cloud Platform - For** **organizational data quality initiatives** (e.g., platform refactoring, governance projects, or AI/ML adoption). + The Elementary Cloud Platform offers pipeline monitoring, incident management, colum level lineage, dashboards, health scores, and alerts. It empowers data engineers, analytics engineers, and data analysts to collaborate, resolve issues efficiently, and deliver trusted data products. Learn more about the [Elementary Cloud Platform](/cloud/introduction) or [book a demo](https://cal.com/maayansa/elementary-intro-docs). +- **Elementary OSS - For individual use** + The CLI tool is used to send Slack alerts, and self-host the Elementary report. It is the right choice if you’ll be the primary user of Elementary and don't have collaboration needs. Learn more about the CLI tool below. + +See here a [detailed features comparison](/overview/cloud-vs-oss). + ### CLI Guides From d81dff144a0443380904e46685c5ca1d86563e22 Mon Sep 17 00:00:00 2001 From: Maayan-s Date: Wed, 30 Oct 2024 09:54:12 +0200 Subject: [PATCH 2/7] dbt package --- .../oss/oss-introduction-opening.mdx | 1 - docs/_snippets/oss/oss-introduction.mdx | 55 ------------------- docs/guides/modules-overview/dbt-package.mdx | 23 ++++++-- docs/oss/oss-introduction.mdx | 54 +++++++++++++++++- docs/overview/elementary-oss.mdx | 21 ------- 5 files changed, 69 insertions(+), 85 deletions(-) delete mode 100644 docs/_snippets/oss/oss-introduction-opening.mdx delete mode 100644 docs/_snippets/oss/oss-introduction.mdx delete mode 100644 docs/overview/elementary-oss.mdx diff --git a/docs/_snippets/oss/oss-introduction-opening.mdx b/docs/_snippets/oss/oss-introduction-opening.mdx deleted file mode 100644 index 3574e16e5..000000000 --- a/docs/_snippets/oss/oss-introduction-opening.mdx +++ /dev/null @@ -1 +0,0 @@ -Elementary OSS is a CLI tool you can deploy and orchestrate to send Slack alerts and self-host the Elementary report. diff --git a/docs/_snippets/oss/oss-introduction.mdx b/docs/_snippets/oss/oss-introduction.mdx deleted file mode 100644 index 54ad4ce4d..000000000 --- a/docs/_snippets/oss/oss-introduction.mdx +++ /dev/null @@ -1,55 +0,0 @@ - - -Elementary OSS is a CLI tool you can deploy with the [Elementary dbt package](/guides/modules-overview/dbt-package) and orchestrate to send Slack alerts and self-host the Elementary report. - -To gain the most value from Elementary, we recommend using the [Elementary Cloud Platform](/cloud/introduction). - -### Elementary OSS vs Elementary Cloud Platform - -- **Elementary Cloud Platform - For** **organizational data quality initiatives** (e.g., platform refactoring, governance projects, or AI/ML adoption). - The Elementary Cloud Platform offers pipeline monitoring, incident management, colum level lineage, dashboards, health scores, and alerts. It empowers data engineers, analytics engineers, and data analysts to collaborate, resolve issues efficiently, and deliver trusted data products. Learn more about the [Elementary Cloud Platform](/cloud/introduction) or [book a demo](https://cal.com/maayansa/elementary-intro-docs). -- **Elementary OSS - For individual use** - The CLI tool is used to send Slack alerts, and self-host the Elementary report. It is the right choice if you’ll be the primary user of Elementary and don't have collaboration needs. Learn more about the CLI tool below. - -See here a [detailed features comparison](/overview/cloud-vs-oss). - -### CLI Guides - - - - - - - - -
- - - Demo - - -### Supported adapters - - diff --git a/docs/guides/modules-overview/dbt-package.mdx b/docs/guides/modules-overview/dbt-package.mdx index 1680a7999..5f346119c 100644 --- a/docs/guides/modules-overview/dbt-package.mdx +++ b/docs/guides/modules-overview/dbt-package.mdx @@ -3,10 +3,24 @@ title: "Elementary dbt package" sidebarTitle: "Introduction" --- -For data monitoring and dbt artifacts collection, Elementary uses a dbt package. -The package adds models, macros, and Elementary tests as dbt tests to your project. +The Elemenary dbt package serves as a collector of logs and metadata from your dbt project and offers a set of data anomaly detection and schema tests. +To gain the most value from the dbt package, we recommend using it with the [Elementary Cloud Platform](/cloud/introduction) or with [Elementary open-source CLI tool](/oss/oss-introduction). + +**What brings you here?** + +- **An organizational data quality initiative** (e.g., platform refactoring, governance projects, or AI/ML adoption): The Elementary Cloud Platform offers pipeline monitoring, incident management, lineage tracking, dashboards, health scores, and alerts, empowering data engineers, analytics engineers, and data analysts to resolve issues efficiently and deliver trusted data products. Learn more about the [Elementary Cloud Platform](/cloud/introduction) or [book a demo](https://cal.com/maayansa/elementary-intro-docs). +- **Individual-use observability:** If you’ll be the primary user, try the open-source CLI tool to send Slack alerts, and self-host the Elementary report. + +The repository and source code of the Elementary dbt package can be [found here](https://github.com/elementary-data/dbt-data-reliability). + +## Package Features + +The Elementary dbt package is designed to power data observability use cases for dbt pipelines. +This package will upload logs and metadata generated from your runs as dbt artifacts into tables in your datawarehouse. +Additionaly, it offers a wide range of tests, including anomalies in volume, freshness, columns and different dimensions of your data. + +The impact of the package on **`dbt run`** is minimal, and most of the processing happens as part of the data tests that are executed on **`dbt test`**. -The impact of the package on `dbt run` is minimal, and most of the processing happens as part of the data tests that are executed on `dbt test`. A dbt package is additional Jinja and SQL code that is added to your project, for additional functionality. In fact, each package is a dbt project. By adding a package to your project, you are adding the package code to be part of your project, you can reference its macros, execute its models, and so on. @@ -20,9 +34,6 @@ Some packages we recommend you check out: [dbt_utils](https://github.com/dbt-lab -The repository and source code of the Elementary dbt package can be [found here](https://github.com/elementary-data/dbt-data-reliability). - -## Package Features After you deploy the dbt package, you can use Elementary tests, and your dbt artifacts will be uploaded automatically with on-run-end hooks: diff --git a/docs/oss/oss-introduction.mdx b/docs/oss/oss-introduction.mdx index ae8f2221b..8e8453d36 100644 --- a/docs/oss/oss-introduction.mdx +++ b/docs/oss/oss-introduction.mdx @@ -4,7 +4,18 @@ sidebarTitle: "Introduction" icon: "square-terminal" --- - +Elementary OSS is a CLI tool you can deploy with the [Elementary dbt package](/guides/modules-overview/dbt-package) and orchestrate to send Slack alerts and self-host the Elementary report. + +To gain the most value from Elementary, we recommend using the [Elementary Cloud Platform](/cloud/introduction). + +### Elementary OSS vs Elementary Cloud Platform + +- **Elementary Cloud Platform** - **Recommended for organizational data quality initiatives** (e.g., platform refactoring, governance projects, or AI/ML adoption). + The Elementary Cloud Platform offers pipeline monitoring, incident management, colum level lineage, dashboards, health scores, and alerts. It empowers data engineers, analytics engineers, and data analysts to collaborate, resolve issues efficiently, and deliver trusted data products. Learn more about the [Elementary Cloud Platform](/cloud/introduction) or [book a demo](https://cal.com/maayansa/elementary-intro-docs). +- **Elementary OSS** - **Recommended for local or individual use.** + The CLI tool is used to send Slack alerts, and self-host the Elementary report. It is the right choice if you’ll be the primary user of Elementary and don't have collaboration needs. Learn more about the CLI tool below. + +See here a [detailed features comparison](/overview/cloud-vs-oss). - +### CLI Guides + + + + + + + + +
+ + + Demo + + +### Supported adapters + + \ No newline at end of file diff --git a/docs/overview/elementary-oss.mdx b/docs/overview/elementary-oss.mdx deleted file mode 100644 index f76ddc729..000000000 --- a/docs/overview/elementary-oss.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Elementary OSS" -sidebarTitle: "Elementary OSS" -icon: "square-terminal" ---- - - - - - - Install and configure the Elementary dbt package and CLI tool. - - - Read more about Elementary OSS usage, guides and deployment. - - - - From e5b815fc65c4d8552b34e11633f966ae2f38eaeb Mon Sep 17 00:00:00 2001 From: Maayan-s Date: Wed, 30 Oct 2024 11:15:40 +0200 Subject: [PATCH 3/7] power bi icon fix --- .../cloud/integrations/cards-groups/bi-cards.mdx | 13 +++++-------- docs/overview/cloud-vs-oss.mdx | 4 ++-- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx b/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx index d065112b1..f3fb0087f 100644 --- a/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx +++ b/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx @@ -85,15 +85,12 @@ - - - - - - - + + + + } > diff --git a/docs/overview/cloud-vs-oss.mdx b/docs/overview/cloud-vs-oss.mdx index d0bbc3171..b211b676c 100644 --- a/docs/overview/cloud-vs-oss.mdx +++ b/docs/overview/cloud-vs-oss.mdx @@ -8,7 +8,7 @@ icon: "list-check" ### Elementary Cloud Ideal for teams monitoring mission-critical data pipelines, requiring guaranteed uptime and reliability, short-time-to-value, advanced features, collaboration, and professional support. The solution is secure by design, and requires no access to your data from cloud. -### Elementary Community +### Elementary OSS An open-source CLI tool you can deploy and orchestrate to send Slack alerts and self-host the Elementary report. It is best for data and analytics engineers that require basic observability capabilities or for evaluating features without vendor approval. ### Features comparison @@ -37,7 +37,7 @@ An open-source CLI tool you can deploy and orchestrate to send Slack alerts and | Additional alert destinations:
PagerDuty, OpsGenie, Webhook | ❌ | ✅ | | Alert actions | ❌ | ✅ | | Data catalog | ❌ | ✅ | -| Data Health Score | ❌ | ✅ | +| Data Health Scores | ❌ | ✅ | | Incident management | ❌ | ✅ | | **Deployment, security and service** | | | | Deployment | Self hosted, CLI | Cloud service | From f27111292a0d4abf0199b9f8959780ec304d0110 Mon Sep 17 00:00:00 2001 From: Maayan-s Date: Wed, 30 Oct 2024 12:11:34 +0200 Subject: [PATCH 4/7] Sigma icon --- docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx b/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx index f3fb0087f..907c240dd 100644 --- a/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx +++ b/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx @@ -109,10 +109,9 @@ - - + } > Click for details From d2b646b3b8269424d5861a2a4154c41689e5b0ae Mon Sep 17 00:00:00 2001 From: Maayan-s Date: Tue, 12 Nov 2024 20:13:51 +0200 Subject: [PATCH 5/7] Sigma icon --- docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx b/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx index 907c240dd..945099cf5 100644 --- a/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx +++ b/docs/_snippets/cloud/integrations/cards-groups/bi-cards.mdx @@ -114,7 +114,6 @@ } > - Click for details Date: Tue, 12 Nov 2024 20:14:11 +0200 Subject: [PATCH 6/7] version --- docs/_snippets/quickstart-package-install.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_snippets/quickstart-package-install.mdx b/docs/_snippets/quickstart-package-install.mdx index dae3e28b6..654cbbb60 100644 --- a/docs/_snippets/quickstart-package-install.mdx +++ b/docs/_snippets/quickstart-package-install.mdx @@ -39,7 +39,7 @@ Some packages we recommend you check out: [dbt_utils](https://github.com/dbt-lab ```yml packages.yml packages: - package: elementary-data/elementary - version: 0.15.2 + version: 0.16.1 ## Docs: https://docs.elementary-data.com ``` From 56e518224a55675c5e9fa18577ce6e7536089f69 Mon Sep 17 00:00:00 2001 From: Maayan-s Date: Tue, 12 Nov 2024 20:20:31 +0200 Subject: [PATCH 7/7] typos --- docs/guides/modules-overview/dbt-package.mdx | 2 +- docs/oss/oss-introduction.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/modules-overview/dbt-package.mdx b/docs/guides/modules-overview/dbt-package.mdx index 5f346119c..29a8c7cc7 100644 --- a/docs/guides/modules-overview/dbt-package.mdx +++ b/docs/guides/modules-overview/dbt-package.mdx @@ -17,7 +17,7 @@ The repository and source code of the Elementary dbt package can be [found here] The Elementary dbt package is designed to power data observability use cases for dbt pipelines. This package will upload logs and metadata generated from your runs as dbt artifacts into tables in your datawarehouse. -Additionaly, it offers a wide range of tests, including anomalies in volume, freshness, columns and different dimensions of your data. +Additionally, it offers a wide range of tests, including anomalies in volume, freshness, columns and different dimensions of your data. The impact of the package on **`dbt run`** is minimal, and most of the processing happens as part of the data tests that are executed on **`dbt test`**. diff --git a/docs/oss/oss-introduction.mdx b/docs/oss/oss-introduction.mdx index 8e8453d36..560b62e70 100644 --- a/docs/oss/oss-introduction.mdx +++ b/docs/oss/oss-introduction.mdx @@ -11,7 +11,7 @@ To gain the most value from Elementary, we recommend using the [Elementary Cloud ### Elementary OSS vs Elementary Cloud Platform - **Elementary Cloud Platform** - **Recommended for organizational data quality initiatives** (e.g., platform refactoring, governance projects, or AI/ML adoption). - The Elementary Cloud Platform offers pipeline monitoring, incident management, colum level lineage, dashboards, health scores, and alerts. It empowers data engineers, analytics engineers, and data analysts to collaborate, resolve issues efficiently, and deliver trusted data products. Learn more about the [Elementary Cloud Platform](/cloud/introduction) or [book a demo](https://cal.com/maayansa/elementary-intro-docs). + The Elementary Cloud Platform offers pipeline monitoring, incident management, column level lineage, dashboards, health scores, and alerts. It empowers data engineers, analytics engineers, and data analysts to collaborate, resolve issues efficiently, and deliver trusted data products. Learn more about the [Elementary Cloud Platform](/cloud/introduction) or [book a demo](https://cal.com/maayansa/elementary-intro-docs). - **Elementary OSS** - **Recommended for local or individual use.** The CLI tool is used to send Slack alerts, and self-host the Elementary report. It is the right choice if you’ll be the primary user of Elementary and don't have collaboration needs. Learn more about the CLI tool below.