Skip to content

Commit

Permalink
Documentation edits made through Mintlify web editor (#1782)
Browse files Browse the repository at this point in the history
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
  • Loading branch information
mintlify[bot] authored Jan 14, 2025
1 parent b4a43f5 commit 74e885a
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 112 deletions.
21 changes: 6 additions & 15 deletions docs/cloud/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ icon: "cloud"

**Elementary is a data observability platform tailored for dbt-first data organizations.**

The unique dbt-native architecture seamlessly integrates into engineers' workflows, ensuring ease of use and smooth adoption.
The unique dbt-native architecture seamlessly integrates into engineers' workflows, ensuring ease of use and smooth adoption.
The platform provides out-of-the-box monitoring for critical issues, tools to effortlessly increase coverage, and integrations for end-to-end visibility across the data stack.

Elementary promotes ownership and collaboration on incidents, and enables the whole data organization to take an active role in the data quality process.
By automatically measuring and tracking data health, it helps teams transition from reactive firefighting to proactively communicating data health to consumers and stakeholders.

<Card title="When do I need a data observability platform? " href="/resources/business-case-data-observability-platform">
</Card>

<Card title="When do I need a data observability platform? " href="/resources/business-case-data-observability-platform" />

## Cloud Platform Features

Expand All @@ -27,18 +25,11 @@ By automatically measuring and tracking data health, it helps teams transition f
Our product is designed with [Security and Privacy](/cloud/general/security-and-privacy) in mind.

<Check>
**SOC 2 certification:** Elementary is SOC2 type II certified!
**SOC 2 certification:** Elementary is SOC2 type II certified!
</Check>

## How to Start?

## How to Start?

<Card
title="Quick start"
href="/quickstart"
></Card>
<Card title="Quick start" href="/quickstart" />

<Card
title="Book a call with our team"
href="https://cal.com/maayansa/elementary-intro-docs"
></Card>
<Card title="Book a call with our team" href="https://meetings-eu1.hubspot.com/joost-boonzajer-flaes/intro-call-docs" />
13 changes: 4 additions & 9 deletions docs/features/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,12 @@ When making changes to your data project, it can sometimes be hard to fully unde
Our impact analysis will run on every pull request in your dbt project, so that you can see the downstream impact of your changes.
You'll also be able to see if any of your dbt tests are failing or your models aren't being built successfully.

<img src="/pics/cloud/pr_impact_example.png" />
![](/pics/cloud/pr_impact_example.png)

Elementary CI automations help you make changes with confidence by providing a comprehensive view before merging your pull request.

## Want to join the beta?

<Card
title="Schedule a call"
href="https://cal.com/maayansa/elementary-intro-docs"
></Card>
<Card
title="Reach out to us on Slack"
href="https://elementary-data.com/community"
></Card>
<Card title="Schedule a call" href="https://meetings-eu1.hubspot.com/joost-boonzajer-flaes/intro-call-docs" />

<Card title="Reach out to us on Slack" href="https://elementary-data.com/community" />
34 changes: 17 additions & 17 deletions docs/guides/modules-overview/dbt-package.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ To gain the most value from the dbt package, we recommend using it with the [Ele

**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.
* **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://meetings-eu1.hubspot.com/joost-boonzajer-flaes/intro-call-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).

Expand All @@ -21,26 +22,25 @@ Additionally, it offers a wide range of tests, including anomalies in volume, fr

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`**.


<Accordion title="What are dbt packages and packages.yml?">
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.

Add packages to your project by creating a `packages.yml` file under the main project directory (where your `
dbt_project.yml` is), and adding the relevant package. After you add a new package, run `dbt deps` to actually pull its
code to your project. This is also how you update packages.
Some packages we recommend you check out: [dbt_utils](https://github.com/dbt-labs/dbt-utils/tree/0.8.2/)
, [dbt_date](https://github.com/calogica/dbt-date/tree/0.5.4/)
, [codegen](https://github.com/dbt-labs/dbt-codegen/tree/0.5.0/).

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.

Add packages to your project by creating a `packages.yml` file under the main project directory (where your `
dbt_project.yml` is), and adding the relevant package. After you add a new package, run `dbt deps` to actually pull its
code to your project. This is also how you update packages.
Some packages we recommend you check out: [dbt\_utils](https://github.com/dbt-labs/dbt-utils/tree/0.8.2/)
, [dbt\_date](https://github.com/calogica/dbt-date/tree/0.5.4/)
, [codegen](https://github.com/dbt-labs/dbt-codegen/tree/0.5.0/).
</Accordion>


After you deploy the dbt package, you can use Elementary tests, and your dbt artifacts will be uploaded automatically with on-run-end hooks:

<CardGroup cols={3}>
<Card title="Elementary data tests" href="/features/data-tests"></Card>
<Card title="dbt artifacts" href="/dbt/dbt-artifacts"></Card>
<Card title="on-run-end hooks" href="/dbt/on-run-end_hooks"></Card>
<Card title="Elementary data tests" href="/features/data-tests" />

<Card title="dbt artifacts" href="/dbt/dbt-artifacts" />

<Card title="on-run-end hooks" href="/dbt/on-run-end_hooks" />
</CardGroup>

Although you can use the package only, we recommend using it with Elementary Cloud or OSS.
Expand All @@ -63,4 +63,4 @@ the following var:
```yaml
vars:
elementary_full_refresh: true
```
```
26 changes: 5 additions & 21 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,10 @@ description: "dbt-native data observability platform built for data and analytic
icon: "fire"
---


<div className="dark:#4A165C rounded-md p-0">
<img
src="https://res.cloudinary.com/diuctyblm/image/upload/v1699193505/mintlify_header_eqa3jy.png"
alt="Elementary banner"
/>
<img src="https://res.cloudinary.com/diuctyblm/image/upload/v1699193505/mintlify_header_eqa3jy.png" alt="Elementary banner" />
</div>


Elementary includes two products:

<Snippet file="quickstart/quickstart-cards.mdx" />
Expand All @@ -28,16 +23,14 @@ See the [detailed comparison](/overview/cloud-vs-oss) between Elementary and Ele

Or - Start with [Elementary Community](/oss/quickstart/quickstart-cli-package), open-source CLI tool you can deploy and orchestrate to send Slack alerts and self-host the Elementary report.


## Why choose Elementary?

<AccordionGroup>
<Accordion title="Built for data developers" icon="code" iconType="solid">
Elementary configuration is managed in your dbt code.
Elementary configuration is managed in your dbt code.
Elementary Cloud syncs configuration changes from the UI back to the dbt project code repository.

You won't need to duplicate configuration - all your existing tests, owners, tags, and descriptions are leveraged.

</Accordion>

<Accordion title="Secure by design" icon="lock" iconType="solid">
Expand All @@ -46,26 +39,17 @@ Or - Start with [Elementary Community](/oss/quickstart/quickstart-cli-package),
The dbt package creates a schema for logs, results and metadata, and Elementary only requires access to the Elementary schema.

[Read about Security and Privacy >>>](/cloud/general/security-and-privacy)

</Accordion>

<Accordion title="dbt native" icon="cube">
Elementary dbt package automatically collects results and artifacts from your dbt project. All of your Elementary configuration is managed in your dbt code.

By combining the package and Elementary Cloud, you get full dbt observability. All your tests and results in one dashboard and interface.

</Accordion>

</AccordionGroup>


## Want to know more?

<Card
title="Book a call with our team"
href="https://cal.com/maayansa/elementary-intro-docs"
></Card>
<Card
title="Reach out to us on Slack"
href="https://elementary-data.com/community"
></Card>
<Card title="Book a call with our team" href="https://meetings-eu1.hubspot.com/joost-boonzajer-flaes/intro-call-docs" />

<Card title="Reach out to us on Slack" href="https://elementary-data.com/community" />
4 changes: 2 additions & 2 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
{
"name": "Book a Demo",
"icon": "calendar-check",
"url": "https://cal.com/maayansa/elementary-intro-docs"
"url": "https://meetings-eu1.hubspot.com/joost-boonzajer-flaes/intro-call-docs"
},
{
"name": "Join Slack",
Expand Down Expand Up @@ -519,4 +519,4 @@
"destination": "/features/collaboration-and-communication/data-observability-dashboard"
}
]
}
}
2 changes: 1 addition & 1 deletion docs/oss/oss-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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, 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).
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://meetings-eu1.hubspot.com/joost-boonzajer-flaes/intro-call-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.
Expand Down
Loading

0 comments on commit 74e885a

Please sign in to comment.