Skip to content
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.

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

[DOCS]: Adds Welcome Section and "What Is Cosmos" Blurb to Home Page #1251

Merged
merged 10 commits into from
Oct 17, 2024

Conversation

cmarteepants
Copy link
Collaborator

@cmarteepants cmarteepants commented Oct 12, 2024

Summary

  • Enhanced the documentation by adding a welcome section and a detailed explanation of what Astronomer Cosmos is to the index / home page
  • Expanded example usage by
    • Explaining how a workflow looks like in DBT and providing a visual of the dbt graph
    • Explaining the role of DbtDag
  • Added a call to action for community involvement via Slack and Github
  • Minor fixes, including adding missing backticks

Changes

  • Updated index.rst (+72 additions, -19 deletions)
  • Added new image: jaffle_shop_dbt_graph.png

Related Issue(s)

Part of #1225

- Updated `index.rst` to enhance the documentation structure
- Included a welcome section and detailed explanation of Cosmos
- Expanded example usage with dbt graph and more usage details
Copy link

netlify bot commented Oct 12, 2024

Deploy Preview for sunny-pastelito-5ecb04 canceled.

Name Link
🔨 Latest commit 555fbb4
🔍 Latest deploy log https://app.netlify.com/sites/sunny-pastelito-5ecb04/deploys/6710098af4df8900084d9746

Copy link

codecov bot commented Oct 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.73%. Comparing base (ae4ec78) to head (555fbb4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1251   +/-   ##
=======================================
  Coverage   95.73%   95.73%           
=======================================
  Files          67       67           
  Lines        3965     3965           
=======================================
  Hits         3796     3796           
  Misses        169      169           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cmarteepants cmarteepants marked this pull request as ready for review October 15, 2024 18:24
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Oct 15, 2024
@dosubot dosubot bot added the area:docs Relating to documentation, changes, fixes, improvement label Oct 15, 2024
@cmarteepants cmarteepants changed the title docs: add welcome section and cosmos explanation Docs: Adds Welcome Section and "What Is Cosmos" Blurb to Home Page Oct 15, 2024
@cmarteepants cmarteepants mentioned this pull request Oct 15, 2024
9 tasks
@cmarteepants cmarteepants changed the title Docs: Adds Welcome Section and "What Is Cosmos" Blurb to Home Page [DOCS]: Adds Welcome Section and "What Is Cosmos" Blurb to Home Page Oct 15, 2024
docs/index.rst Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
Copy link
Contributor

@yanmastin-astro yanmastin-astro left a comment

Choose a reason for hiding this comment

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

Minor punctuation and grammar fixes but everything else looks great!

docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
Co-authored-by: yanmastin-astro <[email protected]>
Co-authored-by: yanmastin-astro <[email protected]>
Copy link
Contributor

@yanmastin-astro yanmastin-astro left a comment

Choose a reason for hiding this comment

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

One more minor formatting fix to remove line break in list

docs/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@pankajkoti pankajkoti left a comment

Choose a reason for hiding this comment

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

LGTM. Would be nice to confirm if the path to the jaffle_shop_dbt_graph.png image works well. Anyhow, I guess we should be able to quickly iterate through that later in a subsequent PR if we see any issues with it.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 16, 2024
@cmarteepants cmarteepants merged commit a2088d5 into main Oct 17, 2024
68 checks passed
@cmarteepants cmarteepants deleted the docs-improvements branch October 17, 2024 21:12
@tatiana tatiana added this to the Cosmos 1.7.1 milestone Oct 25, 2024
tatiana added a commit that referenced this pull request Oct 29, 2024
Bug fixes

* Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python path by kesompochy in #1252
* Fix displaying dbt docs as menu item in Astro by @tatiana in #1280
* Fix: Replace login by user for clickhouse profile by @petershenri in #1255

Enhancements

* Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html by @johnmcochran in #1250
* Minor refactor on VirtualenvOperators & add test for PR by @tatiana in #1253

Docs

* Add Welcome Section and "What Is Cosmos" Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284
* Fix release after the ``raw`` rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template ``bug.yml`` - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244"
error: pathspec 'Is' did not match any file(s) known to git
error: pathspec 'Cosmos Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update CODEOWNERS to track all files by @pankajkoti in #1284
* Fix release after the raw rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template bug.yml - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244
@tatiana tatiana mentioned this pull request Oct 29, 2024
tatiana added a commit that referenced this pull request Oct 29, 2024
Bug fixes

* Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python path by kesompochy in #1252
* Fix displaying dbt docs as menu item in Astro by @tatiana in #1280
* Fix: Replace login by user for clickhouse profile by @petershenri in #1255

Enhancements

* Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html by @johnmcochran in #1250
* Minor refactor on VirtualenvOperators & add test for PR by @tatiana in #1253

Docs

* Add Welcome Section and "What Is Cosmos" Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284
* Fix release after the ``raw`` rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template ``bug.yml`` - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244"
error: pathspec 'Is' did not match any file(s) known to git
error: pathspec 'Cosmos Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update CODEOWNERS to track all files by @pankajkoti in #1284
* Fix release after the raw rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template bug.yml - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244
tatiana added a commit that referenced this pull request Oct 29, 2024
Bug fixes

* Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python
path by @kesompochy in #1252
* Fix displaying dbt docs as menu item in Astro by @tatiana in #1280
* Fix: Replace login by user for clickhouse profile by @petershenri in
#1255

Enhancements

* Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html
by @johnmcochran in #1250
* Minor refactor on VirtualenvOperators & add test for PR by @tatiana in
#1253

Docs

* Add Welcome Section and "What Is Cosmos" Blurb to Home Page by
@cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by
@pankajkoti in #1283
* Add a dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284
* Fix release after the ``raw`` rst directive disabled was disabled in
PyPI by @tatiana in #1282
* Update issue template ``bug.yml`` - cosmos version update in the
dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Relating to documentation, changes, fixes, improvement lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants