Conversation
Updating README with changes wrote with Roni
|
👋 @NoyaOffer |
| - What's Inside the Elementary dbt Package? | ||
| - Quick start - dbt package | ||
| - Get more out of Elementary dbt package | ||
| - Metadata tables - Run Results and dbt artifacts | ||
| - Data anomaly detection as dbt tests | ||
| - [Community & Support](https://www.notion.so/dbt-README-1ab621a084bf8027ac32e8b6f663a231?pvs=21) | ||
| - [Contribution](https://www.notion.so/dbt-README-1ab621a084bf8027ac32e8b6f663a231?pvs=21) |
There was a problem hiding this comment.
We previously had links to the relevant sections, and now we only have links for the "Community" and "Contribution" sections.
There was a problem hiding this comment.
fixed in readme_changes-1
| - [Contribution](#contributions) | ||
| ✅ [**Elementary Open Source**](https://docs.elementary-data.com/oss/oss-introduction) – A powerful, self-hosted tool for teams that want full control. | ||
|
|
||
| ✅ [**Elementary Cloud Platform**](https://docs.elementary-data.com/cloud/introduction) – A fully managed, enterprise-ready solution with **ML-powered anomaly detection, flexible data discovery, integrated incident management, and collaboration tools**—all with minimal setup and infrastructure maintenance. |
There was a problem hiding this comment.
Maybe add automated? WDYT?
| ✅ [**Elementary Cloud Platform**](https://docs.elementary-data.com/cloud/introduction) – A fully managed, enterprise-ready solution with **ML-powered anomaly detection, flexible data discovery, integrated incident management, and collaboration tools**—all with minimal setup and infrastructure maintenance. | |
| ✅ [**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. |
There was a problem hiding this comment.
fixed in readme_changes-1
| 1. Run `dbt deps` | ||
| 2. Add to your `dbt_project.yml`: |
There was a problem hiding this comment.
Fix the numbers
| 1. Run `dbt deps` | |
| 2. Add to your `dbt_project.yml`: | |
| 2. Run `dbt deps` | |
| 3. Add to your `dbt_project.yml`: |
There was a problem hiding this comment.
fixed in readme_changes-1
| ``` | ||
|
|
||
| 4. Run `dbt run --select elementary` | ||
| 1. Run `dbt run --select elementary` |
There was a problem hiding this comment.
Here too
| 1. Run `dbt run --select elementary` | |
| 4. Run `dbt run --select elementary` |
There was a problem hiding this comment.
fixed in readme_changes-1
| - **dbt_models** – Details on all dbt models. | ||
| - **dbt_tests** – Stores information about dbt tests. | ||
| - **dbt_sources** – Tracks source tables and freshness checks. | ||
| - **dbt_exposures** – Logs downstream data usage. | ||
| - **dbt_metrics** – Captures dbt-defined metrics. | ||
| - **dbt_snapshots** – Stores historical snapshot data. |
There was a problem hiding this comment.
Presenting these tables before the Run Results Tables could be more logical, as all the tables there are connected to objects in one of the dbt_X tables.
There was a problem hiding this comment.
fixed in readme_changes-1
|
|
||
| **Elementary tests are configured and executed like native tests in your project!** | ||
|
|
||
| Elementary dbt tests track key metrics and metadata over time, including freshness, volume, schema changes, distribution, cardinality, and more. |
There was a problem hiding this comment.
Schema changes are not related to anomaly detections.
| @@ -106,19 +127,10 @@ models: | |||
| tests: | |||
| - elementary.table_anomalies | |||
There was a problem hiding this comment.
fixed in readme_changes-1
| <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> | ||
| </kbd> | ||
| Read more about the available [Elementary tests and configuration](https://docs.elementary-data.com/data-tests/introduction). |
There was a problem hiding this comment.
What are your thoughts on including the test list here before directing users to another site to view the tests? It would be similar to how we showcase the table artifacts list before guiding them to our site for more information. This package's core functionality lies in this feature!
There was a problem hiding this comment.
fixed in readme_changes-1
| <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> | ||
| </kbd> | ||
| Read more about the available [Elementary tests and configuration](https://docs.elementary-data.com/data-tests/introduction). |
There was a problem hiding this comment.
Regarding:
Check out the contributions guide
It redirects to "Welcome to Elementary"
There was a problem hiding this comment.
fixed in readme_changes-1
| - An open-source CLI tool you can deploy and orchestrate to send alerts and self-host the Elementary report. Best for data and analytics engineers that require basic observability capabilities or for evaluating features without vendor approval. Our community can provide great support on [Slack](https://www.elementary-data.com/community) if needed. | ||
| To generate observability reports, send alerts, and govern your data quality effectively, connect your dbt package to one of the following options: | ||
|
|
||
| - **Elementary OSS** |
There was a problem hiding this comment.
I think we should add a link here to the Python package OSS.
There was a problem hiding this comment.
@NoyaOffer What do you think? a link to the repo?
2 participants
Updating README with changes wrote with Roni :)