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.

Sign up for GitHub

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

Jump to bottom

Improve Cosmos docs #1225

Open
3 of 9 tasks
tatiana opened this issue Sep 25, 2024 · 1 comment
Open
3 of 9 tasks

Improve Cosmos docs #1225

tatiana opened this issue Sep 25, 2024 · 1 comment
Assignees
@cmarteepants
Labels
area:docs Relating to documentation, changes, fixes, improvement

Comments

@tatiana
Copy link
Collaborator

tatiana commented Sep 25, 2024 •
edited by cmarteepants
Loading

(Written by @cmarteepants):

This ticket aims to make our docs more beginner friendly. This includes have more information about the problem that Cosmos aims to solve, adding more in-depth explanations for core concepts, and reorganizing content to make features more discoverable.

ToDo's:

  • Home / index: ([DOCS]: Adds Welcome Section and "What Is Cosmos" Blurb to Home Page #1251)
    • Add welcome text, and brief explanation for what Cosmos is and problem it tries to solve
    • Add a call to action to join the community
    • (Potentially) Explain doc layout
  • Create a dedicated "First Steps" section with:
    • Overview: Deeper explanation for what Cosmos is, benefits, and example usage, and
    • Quick Start: Simple example that anybody can run locally (either using Astro CLI, or Airflow OSS)
  • Create an Installation Section (revamp Getting Started)
  • Create an Explore Concepts section to explain the different types of configs (Project, Profile, Execution, Render) and features (generating and hosting docs, only running a subset of dbt resources, scheduling options)
@tatiana tatiana mentioned this issue Sep 25, 2024
Merged
@dosubot dosubot bot added the area:docs Relating to documentation, changes, fixes, improvement label Sep 25, 2024
@cmarteepants cmarteepants mentioned this issue Oct 12, 2024
Merged
@cmarteepants cmarteepants self-assigned this Oct 15, 2024
@cmarteepants
Copy link
Collaborator

From @tatiana: Another thing we may want to address is to remove the duplicate between README.md and index.rst
#1221

cmarteepants added a commit that referenced this issue Oct 17, 2024
@cmarteepants @yanmastin-astro
[DOCS]: Adds Welcome Section and "What Is Cosmos" Blurb to Home Page (#…
a2088d5 
…1251)

## 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

---------

Co-authored-by: yanmastin-astro <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cmarteepants cmarteepants

Labels
area:docs Relating to documentation, changes, fixes, improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tatiana @cmarteepants