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

Update docs structure and add getting started guides #374

Merged
merged 25 commits into from
Jul 26, 2023
Merged

Conversation

jlaneve
Copy link
Collaborator

@jlaneve jlaneve commented Jul 18, 2023

Description

This PR updates the docs site with a better structure. It also adds getting started guides for each of the popular ways of running Airflow.

Related Issue(s)

Closes: #219
Closes: #316
Closes: #307

Breaking Change?

Checklist

  • I have made corresponding changes to the documentation (if required)
  • I have added tests that prove my fix is effective or that my feature works

@netlify
Copy link

netlify bot commented Jul 18, 2023

👷 Deploy Preview for amazing-pothos-a3bca0 processing.

Name Link
🔨 Latest commit ef59a61
🔍 Latest deploy log https://app.netlify.com/sites/amazing-pothos-a3bca0/deploys/64c18cb6f0948f00084f6420

@codecov
Copy link

codecov bot commented Jul 18, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (93d63d4) 91.21% compared to head (ef59a61) 91.21%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #374   +/-   ##
=======================================
  Coverage   91.21%   91.21%           
=======================================
  Files          48       48           
  Lines        1684     1684           
=======================================
  Hits         1536     1536           
  Misses        148      148           
Files Changed Coverage Δ
cosmos/hooks/subprocess.py 82.60% <ø> (ø)

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

Copy link
Collaborator

@tatiana tatiana left a comment

Choose a reason for hiding this comment

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

This is looking great, @jlaneve ! It will be super helpful for Cosmos users. I'm adding a few comments in-line.

docs/conf.py Show resolved Hide resolved
docs/configuration/parsing-methods.rst Show resolved Hide resolved
docs/configuration/parsing-methods.rst Show resolved Hide resolved
docs/configuration/parsing-methods.rst Show resolved Hide resolved
docs/configuration/parsing-methods.rst Show resolved Hide resolved
docs/configuration/selecting-excluding.rst Outdated Show resolved Hide resolved
docs/configuration/selecting-excluding.rst Outdated Show resolved Hide resolved
docs/configuration/selecting-excluding.rst Outdated Show resolved Hide resolved
docs/configuration/selecting-excluding.rst Outdated Show resolved Hide resolved
docs/configuration/selecting-excluding.rst Outdated Show resolved Hide resolved
@jlaneve jlaneve marked this pull request as ready for review July 26, 2023 21:14
@jlaneve jlaneve requested a review from a team as a code owner July 26, 2023 21:14
@jlaneve jlaneve requested a review from a team July 26, 2023 21:14
@jlaneve jlaneve merged commit 554f250 into main Jul 26, 2023
39 checks passed
@jlaneve jlaneve deleted the docs-updated branch July 26, 2023 22:02
tatiana pushed a commit that referenced this pull request Aug 9, 2023
## Description

<!-- Add a brief but complete description of the change. -->

This PR updates the docs site with a better structure. It also adds
getting started guides for each of the popular ways of running Airflow.

## Related Issue(s)

Closes: #219
Closes: #316 
Closes: #307 

## Breaking Change?

<!-- If this introduces a breaking change, specify that here. -->

## Checklist

- [ ] I have made corresponding changes to the documentation (if
required)
- [ ] I have added tests that prove my fix is effective or that my
feature works

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Harel Shein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants