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

cmarteepants · 2024-10-12T00:14:35Z

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

netlify · 2024-10-12T00:14:56Z

✅ 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

codecov · 2024-10-12T02:04:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.73%. Comparing base (ae4ec78) to head (555fbb4).

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.

pankajastro · 2024-10-15T19:38:12Z

docs/index.rst

+Below, you can see what the original dbt workflow looks like in a lineage graph. This graph helps illustrate the
+relationships between different models:
+
+.. image:: /_static/jaffle_shop_dbt_graph.png


Suggested change

.. image:: /_static/jaffle_shop_dbt_graph.png

.. image:: https://raw.githubusercontent.com/astronomer/astronomer-cosmos/main/docs/_static/jaffle_shop_dbt_graph.png

wydt?

When I tried that, it didn't render (I assume because it wasn't in version control yet). What's the difference between this, and using the relative path so that also works locally?

I think they’re just alternatives to each other. I maybe wrong wrt rst syntax, however, I would consider /_static/jaffle_shop_dbt_graph.png to be an absolute path, and I’m unsure how that works :). I’m wondering if the correct relative path should be ./_static/jaffle_shop_dbt_graph.png instead.

When I initially tried https://raw.githubusercontent.com/astronomer/astronomer-cosmos/main/docs/_static/jaffle_shop_dbt_graph.png, I received an error. Intuitively that made sense since the image is new, and does not exist on the main branch.

I then tried ./_static/jaffle_shop_dbt_graph.png, and received the same error. Last attempt was /_static/jaffle_shop_dbt_graph.png, and the docs compiled properly.

As written, the image shows up in the PR preview environment. See here - it's the image for the dbt lineage graph. I'm fine with switching to pulling the image from github main branch if that is what you want, but it means that this PR won't work until after the PR has been merged to main.

pankajastro · 2024-10-15T19:45:32Z

docs/index.rst

+Why Should You Use Cosmos?
+___________________________
+
+Cosmos makes orchestrating dbt workflows:


Suggested change

Cosmos makes orchestrating dbt workflows:

Cosmos makes orchestrating dbt-core workflows:

Shall we use "Dbt-core" instead of "dbt"?

@tatiana / @pankajkoti any thoughts ^^?

not too sure. Maybe we could add a line somewhere that in general when we mean dbt, we're referring to dbt-core workflows throughout the references. no strong opinion.

yanmastin-astro

Minor punctuation and grammar fixes but everything else looks great!

docs/index.rst

Co-authored-by: yanmastin-astro <[email protected]>

yanmastin-astro

One more minor formatting fix to remove line break in list

docs/index.rst

Co-authored-by: yanmastin-astro <[email protected]>

pankajkoti

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.

docs: add welcome section and cosmos explanation

8014500

- 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

cmarteepants temporarily deployed to internal October 12, 2024 00:14 — with GitHub Actions Inactive

gives more context for leveraging DbtDag

2129294

cmarteepants temporarily deployed to internal October 15, 2024 15:45 — with GitHub Actions Inactive

consolidate getting started links

61ab4dc

cmarteepants temporarily deployed to internal October 15, 2024 15:59 — with GitHub Actions Inactive

Merge branch 'main' into docs-improvements

bc8d510

cmarteepants temporarily deployed to internal October 15, 2024 17:08 — with GitHub Actions Inactive

add call to action to join community

62ee76a

cmarteepants temporarily deployed to internal October 15, 2024 18:10 — with GitHub Actions Inactive

add missing backticks

46c8981

cmarteepants temporarily deployed to internal October 15, 2024 18:12 — with GitHub Actions Inactive

cmarteepants marked this pull request as ready for review October 15, 2024 18:24

dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Oct 15, 2024

cmarteepants requested review from pankajastro and tatiana October 15, 2024 18:24

dosubot bot added the area:docs Relating to documentation, changes, fixes, improvement label Oct 15, 2024

cmarteepants requested a review from yanmastin-astro October 15, 2024 18:33

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 mentioned this pull request Oct 15, 2024

Improve Cosmos docs #1225

Open

9 tasks

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

pankajastro reviewed Oct 15, 2024

View reviewed changes

yanmastin-astro approved these changes Oct 16, 2024

View reviewed changes

docs/index.rst Outdated Show resolved Hide resolved

docs/index.rst Show resolved Hide resolved

docs/index.rst Outdated Show resolved Hide resolved

grammar fix

61fa25d

Co-authored-by: yanmastin-astro <[email protected]>

cmarteepants temporarily deployed to internal October 16, 2024 14:50 — with GitHub Actions Inactive

grammar fix

a15f5db

Co-authored-by: yanmastin-astro <[email protected]>

cmarteepants temporarily deployed to internal October 16, 2024 14:50 — with GitHub Actions Inactive

yanmastin-astro approved these changes Oct 16, 2024

View reviewed changes

docs/index.rst Outdated Show resolved Hide resolved

format fix to remove line break in list

cdfd348

Co-authored-by: yanmastin-astro <[email protected]>

cmarteepants temporarily deployed to internal October 16, 2024 15:06 — with GitHub Actions Inactive

pankajkoti approved these changes Oct 16, 2024

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 16, 2024

Merge branch 'main' into docs-improvements

555fbb4

cmarteepants deployed to internal October 16, 2024 18:44 — with GitHub Actions Active

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

cmarteepants commented Oct 12, 2024 •

edited

Loading

netlify bot commented Oct 12, 2024 •

edited

Loading

codecov bot commented Oct 12, 2024 •

edited

Loading

pankajastro Oct 15, 2024

cmarteepants Oct 15, 2024 •

edited

Loading

pankajkoti Oct 16, 2024 •

edited

Loading

cmarteepants Oct 16, 2024

pankajastro Oct 15, 2024

pankajastro Oct 15, 2024

pankajkoti Oct 16, 2024

yanmastin-astro left a comment

yanmastin-astro left a comment

pankajkoti left a comment

	.. image:: /_static/jaffle_shop_dbt_graph.png
	.. image:: https://raw.githubusercontent.com/astronomer/astronomer-cosmos/main/docs/_static/jaffle_shop_dbt_graph.png

	Cosmos makes orchestrating dbt workflows:
	Cosmos makes orchestrating dbt-core workflows:

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

Are you sure you want to change the base?

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

Conversation

cmarteepants commented Oct 12, 2024 • edited Loading

Summary

Changes

Related Issue(s)

netlify bot commented Oct 12, 2024 • edited Loading

✅ Deploy Preview for sunny-pastelito-5ecb04 canceled.

codecov bot commented Oct 12, 2024 • edited Loading

Codecov Report

pankajastro Oct 15, 2024

Choose a reason for hiding this comment

cmarteepants Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

pankajkoti Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

cmarteepants Oct 16, 2024

Choose a reason for hiding this comment

pankajastro Oct 15, 2024

Choose a reason for hiding this comment

pankajastro Oct 15, 2024

Choose a reason for hiding this comment

pankajkoti Oct 16, 2024

Choose a reason for hiding this comment

yanmastin-astro left a comment

Choose a reason for hiding this comment

yanmastin-astro left a comment

Choose a reason for hiding this comment

pankajkoti left a comment

Choose a reason for hiding this comment

cmarteepants commented Oct 12, 2024 •

edited

Loading

netlify bot commented Oct 12, 2024 •

edited

Loading

codecov bot commented Oct 12, 2024 •

edited

Loading

cmarteepants Oct 15, 2024 •

edited

Loading

pankajkoti Oct 16, 2024 •

edited

Loading