Skip to content

Rebrand README: Update Elementary OSS and Cloud descriptions, update … #896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elazarlachkar merged 10 commits into from
Dec 4, 2025
Merged

Rebrand README: Update Elementary OSS and Cloud descriptions, update … #896

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6c90465
Rebrand README: Update Elementary OSS and Cloud descriptions, update …
NoyaOffer Nov 30, 2025
83e1c6e
Change intro text
NoyaOffer Nov 30, 2025
bb0d453
Update README.md
NoyaOffer Nov 30, 2025
9bab196
Update Table of Contents in README.md
NoyaOffer Nov 30, 2025
48319df
Update README.md
NoyaOffer Dec 1, 2025
2a311b0
Update README.md
NoyaOffer Dec 1, 2025
66ea065
Update README.md
NoyaOffer Dec 1, 2025
0c6aec7
Update README.md
NoyaOffer Dec 1, 2025
db8f6b4
Update README.md
NoyaOffer Dec 1, 2025
e8d7145
Ran prettier on README
elazarlachkar Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 19 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,31 @@
<p align="center">
<img alt="Logo" src="https://raw.githubusercontent.com/elementary-data/elementary/master/static/github_banner.png"/ width="1000">
<img alt="Logo" src="https://res.cloudinary.com/do5hrgokq/image/upload/v1764493013/github_banner_zp5l2o.png" width="1000">
</p>

# [dbt-native data observability](https://www.elementary-data.com/)

<p align="center">
<a href="https://join.slack.com/t/elementary-community/shared_invite/zt-uehfrq2f-zXeVTtXrjYRbdE_V6xq4Rg"><img src="https://img.shields.io/badge/join-Slack-ff69b4"/></a>
<a href="https://docs.elementary-data.com/quickstart"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a>
<a href="https://docs.elementary-data.com/data-tests/dbt/quickstart-package"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a>
<img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-ff69b4"/>
<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/elementary-lineage?period=total&units=international_system&left_color=grey&right_color=orange"&left_text=Downloads/>
</p>

## What is Elementary?

This dbt-native package powers **Elementary**, helping data and analytics engineers **detect data anomalies** and build **rich metadata tables** from their dbt runs and tests. Gain immediate visibility into data quality trend and uncover potential issues, all within dbt.

Choose the observability tool that fits your needs:

✅ [**Elementary Open Source**](https://docs.elementary-data.com/oss/oss-introduction) – A powerful, self-hosted tool for teams that want full control.
# [dbt-native data observability](https://www.elementary-data.com/)

✅ [**Elementary Cloud Platform**](https://docs.elementary-data.com/cloud/introduction) – A fully managed, enterprise-ready solution with **automated ML-powered anomaly detection, flexible data discovery, integrated incident management, and collaboration tools**—all with minimal setup and infrastructure maintenance.
From the [Elementary](https://www.elementary-data.com/) team, helping you deliver trusted data in the AI era.
Ranked among the top 5 dbt packages and supported by a growing community of thousands.

### Table of Contents
Copy link

@coderabbitai coderabbitai bot Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix table of contents heading level.

The "Table of Contents" heading is ### (h3) but should be ## (h2) to maintain proper markdown heading hierarchy (MD001, heading-increment).

Apply this diff to fix the heading level:

-### Table of Contents
+## Table of Contents
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Table of Contents
## Table of Contents
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

16-16: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents 
In README.md around line 16, the "Table of Contents" heading uses level ### (h3)
which breaks markdown heading hierarchy; change it to ## (h2) by reducing one
pound sign so the heading level is consistent with surrounding content and MD001
checks.


- [What's Inside the Elementary dbt Package?](#whats-inside-the-elementary-dbt-package)
- [Get more out of Elementary dbt package](#get-more-out-of-elementary-dbt-package)
- [Data Anomaly Detection & Schema changes as dbt Tests](#data-anomaly-detection--schema-changes-as-dbt-tests)
- [Elementary Tables - Run Results and dbt Artifacts](#elementary-tables---run-results-and-dbt-artifacts)
- [AI-powered data validation and unstructured data tests](#ai-powered-data-validation-and-unstructured-data-tests)
- [Quickstart - dbt Package](#quickstart---dbt-package)
- [Community & Support](#community--support)
- [Contributions](#contributions)
- [**What's Inside the Elementary dbt Package?**](#whats-inside-the-elementary-dbt-package)
- [**Get more out of Elementary dbt package**](#get-more-out-of-elementary-dbt-package)
- [**Anomaly Detection Tests**](#anomaly-detection-tests)
- [**Schema Tests**](#schema-tests)
- [**Elementary Tables - Run Results and dbt Artifacts**](#elementary-tables---run-results-and-dbt-artifacts)
- [**AI-powered data validation and unstructured data tests**](#ai-powered-data-validation-and-unstructured-data-tests)
- [**Quickstart - dbt Package**](#quickstart---dbt-package)
- [**Community & Support**](#community--support)
- [**Contributions**](#contributions)

### **What's Inside the Elementary dbt Package?**
## **What's Inside the Elementary dbt Package?**

The **Elementary dbt package** is designed to enhance data observability within your dbt workflows. It includes two core components:

Expand All @@ -45,10 +38,10 @@ The **Elementary dbt package** helps you find anomalies in your data and build m

To generate observability reports, send alerts, and govern your data quality effectively, connect your dbt package to one of the following options:

- **Elementary OSS**
- **A self-maintained, open-source CLI** that integrates seamlessly with your dbt project and the Elementary dbt package. It **enables alerting and provides the self-hosted Elementary data observability report**, offering a comprehensive view of your dbt runs, all dbt test results, data lineage, and test coverage. Quickstart [here](https://docs.elementary-data.com/oss/quickstart/quickstart-cli), and our team and community can provide great support on [Slack](https://www.elementary-data.com/community) if needed.
- **Elementary Cloud**
- A **fully managed, enterprise-ready** solution designed for **scalability and automation**. It offers automated **ML-powered anomaly detection**, flexible **data discovery**, an integrated **incident management system**, and **collaboration features.** Delivering **high value with minimal setup and infrastructure maintenance**, it's ideal for teams looking to enhance data reliability without operational overhead. To learn more, [book a demo](https://cal.com/maayansa/elementary-intro-github-package) or [start a trial](https://www.elementary-data.com/signup).
- **Elementary OSS**
**A self-maintained, open-source CLI** that integrates seamlessly with your dbt project and the Elementary dbt package. It **enables alerting and provides the self-hosted Elementary data observability report**, offering a comprehensive view of your dbt runs, all dbt test results, data lineage, and test coverage. Quickstart [here](https://docs.elementary-data.com/oss/quickstart/quickstart-cli), and our team and community can provide great support on [Slack](https://www.elementary-data.com/community) if needed.
- **Elementary Cloud**
A managed, AI-driven control plane for observability, quality, governance, and discovery. It includes automated ML monitoring, column-level lineage from source to BI, a built-in catalog, and AI agents that scale reliability workflows. Cloud supports both engineers and business users, enabling technical depth and simple self-service in one place. To learn more, [book a demo](https://cal.com/maayansa/elementary-intro-github-package) or [start a trial](https://www.elementary-data.com/signup).

<kbd align="center">
<a href="https://storage.googleapis.com/elementary_static/elementary_demo.html"><img align="center" style="max-width:300px;" src="https://raw.githubusercontent.com/elementary-data/elementary/master/static/report_ui.gif"> </a>
Expand Down
Loading