Rebrand README: Update Elementary OSS and Cloud descriptions, update … #896
Conversation
…banner image, and fix quickstart link
WalkthroughREADME.md updated: logo image URL and quickstart link changed; the "What is Elementary?" section removed and product copy reorganized into OSS vs Cloud; Table of Contents entries, headings, anchors, and many paragraph/formatted emphasis items were reworded and restructured. No code or public API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (2)📚 Learning: 2025-08-10T11:29:19.004ZApplied to files:
📚 Learning: 2025-09-15T06:06:05.601ZApplied to files:
🪛 markdownlint-cli2 (0.18.1)README.md5-5: Images should have alternate text (alt text) (MD045, no-alt-text) 6-6: Images should have alternate text (alt text) (MD045, no-alt-text) 16-16: Heading levels should only increment by one level at a time (MD001, heading-increment) 42-42: Link text should be descriptive (MD059, descriptive-link-text) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
👋 @NoyaOffer |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-15T06:06:05.601Z
Learnt from: arbiv
Repo: elementary-data/dbt-data-reliability PR: 861
File: macros/edr/tests/test_utils/clean_elementary_test_tables.sql:45-50
Timestamp: 2025-09-15T06:06:05.601Z
Learning: In the Elementary dbt-data-reliability codebase, the team prefers simpler, direct approaches over creating helper macros for centralized quoting logic, even when it might provide better maintainability across multiple use cases. They value code simplicity and readability over abstraction.
Applied to files:
README.md
📚 Learning: 2025-08-10T11:29:19.004Z
Learnt from: GuyEshdat
Repo: elementary-data/dbt-data-reliability PR: 838
File: integration_tests/tests/dbt_project.py:191-201
Timestamp: 2025-08-10T11:29:19.004Z
Learning: In the Elementary dbt package integration tests, BigQuery works correctly with the default `("database", "schema")` property mapping in the `get_database_and_schema_properties` function. When using `target.database` and `target.schema` in source definitions, BigQuery's dbt adapter handles these references appropriately without requiring special mapping to `project` and `dataset`.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.18.1)
README.md
8-8: Images should have alternate text (alt text)
(MD045, no-alt-text)
9-9: Images should have alternate text (alt text)
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: test (fusion, snowflake) / test
- GitHub Check: test (latest_official, snowflake) / test
- GitHub Check: test (latest_official, clickhouse) / test
- GitHub Check: test (latest_official, bigquery) / test
- GitHub Check: test (fusion, redshift) / test
- GitHub Check: test (latest_official, athena) / test
- GitHub Check: test (latest_official, postgres) / test
- GitHub Check: test (fusion, databricks_catalog) / test
- GitHub Check: test (latest_official, dremio) / test
- GitHub Check: test (latest_pre, postgres) / test
- GitHub Check: test (fusion, bigquery) / test
- GitHub Check: test (latest_official, databricks_catalog) / test
- GitHub Check: test (latest_official, redshift) / test
- GitHub Check: test (latest_official, trino) / test
🔇 Additional comments (4)
README.md (4)
9-9: Verify the updated quickstart documentation link.The quickstart link has been updated per PR objectives. Please confirm that the target URL (https://docs.elementary-data.com/data-tests/dbt/quickstart-package) is accessible and serves the correct documentation.
26-40: Verify TOC anchors match section headers.The new hierarchical Table of Contents structure uses anchor links to section headers throughout the file. Ensure all anchor references (e.g.,
#whats-inside-the-elementary-dbt-package) correctly map to their corresponding section headers. Spot-checking suggests proper alignment, but validate full end-to-end navigation.
20-20: Expanded OSS/Cloud descriptions are clear and well-differentiated.The rebranded descriptions effectively communicate the key differences between Elementary OSS and Cloud, with clear feature highlights for each option. The messaging is consistent with the expanded content in the "Get more out of Elementary dbt package" section.
Also applies to: 22-22
2-2: Verify the new banner image URL is accessible.The banner image URL has been updated to a new Cloudinary CDN resource. Confirm that the image loads correctly and displays properly in the rendered README.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
8-9: Add missing alt text to badge images for accessibility.The badge images lack
altattributes, which impacts accessibility and fails markdownlint compliance (MD045). This was flagged in a previous review and still needs to be addressed.Apply this diff to add descriptive alt text:
<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/data-tests/dbt/quickstart-package"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a> +<a href="https://join.slack.com/t/elementary-community/shared_invite/zt-uehfrq2f-zXeVTtXrjYRbdE_V6xq4Rg"><img alt="Join Elementary community on Slack" src="https://img.shields.io/badge/join-Slack-ff69b4"/></a> +<a href="https://docs.elementary-data.com/data-tests/dbt/quickstart-package"><img alt="Read the quickstart documentation" src="https://img.shields.io/badge/docs-quickstart-orange"/></a>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-15T06:06:05.601Z
Learnt from: arbiv
Repo: elementary-data/dbt-data-reliability PR: 861
File: macros/edr/tests/test_utils/clean_elementary_test_tables.sql:45-50
Timestamp: 2025-09-15T06:06:05.601Z
Learning: In the Elementary dbt-data-reliability codebase, the team prefers simpler, direct approaches over creating helper macros for centralized quoting logic, even when it might provide better maintainability across multiple use cases. They value code simplicity and readability over abstraction.
Applied to files:
README.md
📚 Learning: 2025-08-10T11:29:19.004Z
Learnt from: GuyEshdat
Repo: elementary-data/dbt-data-reliability PR: 838
File: integration_tests/tests/dbt_project.py:191-201
Timestamp: 2025-08-10T11:29:19.004Z
Learning: In the Elementary dbt package integration tests, BigQuery works correctly with the default `("database", "schema")` property mapping in the `get_database_and_schema_properties` function. When using `target.database` and `target.schema` in source definitions, BigQuery's dbt adapter handles these references appropriately without requiring special mapping to `project` and `dataset`.
Applied to files:
README.md
🪛 GitHub Actions: Run pre-commit hooks
README.md
[error] 1-1: Prettier formatting check failed. README.md was modified by the hook; please stage and commit the changes. Run 'pre-commit run --all-files' locally to fix.
🪛 markdownlint-cli2 (0.18.1)
README.md
8-8: Images should have alternate text (alt text)
(MD045, no-alt-text)
9-9: Images should have alternate text (alt text)
(MD045, no-alt-text)
31-31: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: test (fusion, redshift) / test
- GitHub Check: test (latest_official, dremio) / test
- GitHub Check: test (latest_official, postgres) / test
- GitHub Check: test (latest_official, snowflake) / test
- GitHub Check: test (latest_official, databricks_catalog) / test
- GitHub Check: test (fusion, bigquery) / test
- GitHub Check: test (fusion, snowflake) / test
- GitHub Check: test (latest_official, redshift) / test
- GitHub Check: test (latest_official, trino) / test
- GitHub Check: test (fusion, databricks_catalog) / test
- GitHub Check: test (latest_official, athena) / test
- GitHub Check: test (latest_official, clickhouse) / test
- GitHub Check: test (latest_pre, postgres) / test
- GitHub Check: test (latest_official, bigquery) / test
🔇 Additional comments (2)
README.md (2)
1-201: Stage and commit Prettier formatting changes.The pre-commit hook (Prettier) reformatted the README.md file, but the changes were not staged. Run the following command locally to apply the formatting, then stage and commit the changes:
pre-commit run --all-files git add README.md git commit -m "Apply Prettier formatting"
16-22: Content rebranding looks good.The updates clearly distinguish between Elementary OSS and Elementary Cloud offerings, making it easier for users to understand which tool fits their needs. The new descriptions are well-written and provide helpful context about each offering's capabilities.
Also applies to: 45-54
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
1-201: Run Prettier to fix formatting.The pre-commit hook indicates that Prettier formatting is required. The file needs to be reformatted before it can be merged.
Run the following command to apply Prettier formatting:
prettier --write README.mdCommit the formatting changes and push to resolve the pipeline failure.
♻️ Duplicate comments (2)
README.md (2)
8-9: Add alt text to badge images for accessibility and markdownlint compliance.Both badge images lack
altattributes, which impacts accessibility for screen readers and fails markdownlint rule MD045. While line 8 was pre-existing, line 9 was modified; use this opportunity to add descriptive alt text to both.Apply this diff to add alt text:
<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/data-tests/dbt/quickstart-package"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a> +<a href="https://join.slack.com/t/elementary-community/shared_invite/zt-uehfrq2f-zXeVTtXrjYRbdE_V6xq4Rg"><img alt="Join Elementary community on Slack" src="https://img.shields.io/badge/join-Slack-ff69b4"/></a> +<a href="https://docs.elementary-data.com/data-tests/dbt/quickstart-package"><img alt="Read the quickstart documentation" src="https://img.shields.io/badge/docs-quickstart-orange"/></a>
31-32: Fix list indentation in table of contents.Lines 31–32 have 4-space indentation when they should have 2-space indentation to be proper nested items under line 30. This violates markdownlint rule MD007.
Apply this diff to correct the indentation:
- [Elementary Tables - Run Results and dbt Artifacts](#elementary-tables---run-results-and-dbt-artifacts) - - [**Metadata Tables - dbt Artifacts**](#metadata-tables---dbt-artifacts) - - [**Run Results Tables**](#run-results-tables) + - [**Metadata Tables - dbt Artifacts**](#metadata-tables---dbt-artifacts) + - [**Run Results Tables**](#run-results-tables)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-10T11:29:19.004Z
Learnt from: GuyEshdat
Repo: elementary-data/dbt-data-reliability PR: 838
File: integration_tests/tests/dbt_project.py:191-201
Timestamp: 2025-08-10T11:29:19.004Z
Learning: In the Elementary dbt package integration tests, BigQuery works correctly with the default `("database", "schema")` property mapping in the `get_database_and_schema_properties` function. When using `target.database` and `target.schema` in source definitions, BigQuery's dbt adapter handles these references appropriately without requiring special mapping to `project` and `dataset`.
Applied to files:
README.md
📚 Learning: 2025-09-15T06:06:05.601Z
Learnt from: arbiv
Repo: elementary-data/dbt-data-reliability PR: 861
File: macros/edr/tests/test_utils/clean_elementary_test_tables.sql:45-50
Timestamp: 2025-09-15T06:06:05.601Z
Learning: In the Elementary dbt-data-reliability codebase, the team prefers simpler, direct approaches over creating helper macros for centralized quoting logic, even when it might provide better maintainability across multiple use cases. They value code simplicity and readability over abstraction.
Applied to files:
README.md
🪛 GitHub Actions: Run pre-commit hooks
README.md
[error] 1-1: Prettier formatting failed. The hook modified README.md. Run 'pre-commit run --all-files' or 'prettier --write README.md' to fix formatting.
🪛 markdownlint-cli2 (0.18.1)
README.md
8-8: Images should have alternate text (alt text)
(MD045, no-alt-text)
9-9: Images should have alternate text (alt text)
(MD045, no-alt-text)
31-31: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
52-52: Link text should be descriptive
(MD059, descriptive-link-text)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: test (latest_official, dremio) / test
- GitHub Check: test (latest_official, clickhouse) / test
- GitHub Check: test (latest_official, databricks_catalog) / test
- GitHub Check: test (latest_official, snowflake) / test
- GitHub Check: test (latest_official, trino) / test
- GitHub Check: test (latest_official, bigquery) / test
- GitHub Check: test (latest_official, postgres) / test
- GitHub Check: test (latest_official, redshift) / test
- GitHub Check: test (fusion, snowflake) / test
- GitHub Check: test (fusion, databricks_catalog) / test
- GitHub Check: test (fusion, bigquery) / test
- GitHub Check: test (latest_pre, postgres) / test
- GitHub Check: test (latest_official, athena) / test
- GitHub Check: test (fusion, redshift) / test
🔇 Additional comments (1)
README.md (1)
16-22: Content rebranding looks good.The split between Elementary OSS and Elementary Cloud with clear, distinct descriptions is well-executed. The product positioning is now clearer and the distinction between self-maintained OSS and managed Cloud is evident.
Verify that the updated quickstart link on line 9 (
https://docs.elementary-data.com/data-tests/dbt/quickstart-package) resolves correctly and points to the intended package quickstart documentation.
Reorganize the Table of Contents for clarity and consistency.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
README.md (2)
5-6: Add alt text to badge images for accessibility.The badge images on lines 5–6 are missing
altattributes, which impacts accessibility for screen readers and fails markdownlint compliance (MD045).Apply this diff to add descriptive alt text:
-<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/data-tests/dbt/quickstart-package"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a> +<a href="https://join.slack.com/t/elementary-community/shared_invite/zt-uehfrq2f-zXeVTtXrjYRbdE_V6xq4Rg"><img alt="Join Elementary community on Slack" src="https://img.shields.io/badge/join-Slack-ff69b4"/></a> +<a href="https://docs.elementary-data.com/data-tests/dbt/quickstart-package"><img alt="Read the quickstart documentation" src="https://img.shields.io/badge/docs-quickstart-orange"/></a>
41-41: Use descriptive link text instead of "here".The link text
[here]on line 41 is vague and violates markdownlint rule MD059 (descriptive-link-text). This was previously flagged and should be replaced with descriptive text that indicates the destination.Apply this diff to improve link descriptiveness:
-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. +Quickstart with the [Elementary OSS CLI](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.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-15T06:06:05.601Z
Learnt from: arbiv
Repo: elementary-data/dbt-data-reliability PR: 861
File: macros/edr/tests/test_utils/clean_elementary_test_tables.sql:45-50
Timestamp: 2025-09-15T06:06:05.601Z
Learning: In the Elementary dbt-data-reliability codebase, the team prefers simpler, direct approaches over creating helper macros for centralized quoting logic, even when it might provide better maintainability across multiple use cases. They value code simplicity and readability over abstraction.
Applied to files:
README.md
📚 Learning: 2025-08-10T11:29:19.004Z
Learnt from: GuyEshdat
Repo: elementary-data/dbt-data-reliability PR: 838
File: integration_tests/tests/dbt_project.py:191-201
Timestamp: 2025-08-10T11:29:19.004Z
Learning: In the Elementary dbt package integration tests, BigQuery works correctly with the default `("database", "schema")` property mapping in the `get_database_and_schema_properties` function. When using `target.database` and `target.schema` in source definitions, BigQuery's dbt adapter handles these references appropriately without requiring special mapping to `project` and `dataset`.
Applied to files:
README.md
🪛 GitHub Actions: Run pre-commit hooks
README.md
[error] 1-1: Prettier formatting check failed. The hook modified the file README.md. Run 'prettier --write' to fix code style issues.
🪛 markdownlint-cli2 (0.18.1)
README.md
5-5: Images should have alternate text (alt text)
(MD045, no-alt-text)
6-6: Images should have alternate text (alt text)
(MD045, no-alt-text)
16-16: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
41-41: Link text should be descriptive
(MD059, descriptive-link-text)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: test (latest_official, snowflake) / test
- GitHub Check: test (latest_official, dremio) / test
- GitHub Check: test (latest_official, clickhouse) / test
- GitHub Check: test (latest_official, postgres) / test
- GitHub Check: test (latest_official, redshift) / test
- GitHub Check: test (fusion, redshift) / test
- GitHub Check: test (latest_official, athena) / test
- GitHub Check: test (fusion, snowflake) / test
- GitHub Check: test (latest_official, databricks_catalog) / test
- GitHub Check: test (fusion, databricks_catalog) / test
- GitHub Check: test (latest_pre, postgres) / test
- GitHub Check: test (latest_official, trino) / test
- GitHub Check: test (fusion, bigquery) / test
- GitHub Check: test (latest_official, bigquery) / test
🔇 Additional comments (3)
README.md (3)
11-14: Rebranding content looks good.The new title and introductory copy effectively position Elementary in the AI era context and align with the rebranding objectives.
45-179: Content restructuring looks appropriate.The reorganization of test documentation, table descriptions, and AI feature sections maintains logical flow and clarity. Documentation links and examples are intact.
1-189: Run Prettier to fix formatting issues.The pipeline failed the Prettier formatting check. Before merging, run the following command to auto-fix formatting and style issues:
prettier --write README.mdLikely an incorrect or invalid review comment.
| 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 |
There was a problem hiding this comment.
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.
| ### 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.
…banner image, and fix quickstart link
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.