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

The Contributor's Quick Start isn't quick enough and needs some TLC #39653

Open
2 tasks done
RNHTTR opened this issue May 15, 2024 · 5 comments · May be fixed by #39837
Open
2 tasks done

The Contributor's Quick Start isn't quick enough and needs some TLC #39653

RNHTTR opened this issue May 15, 2024 · 5 comments · May be fixed by #39837
Assignees

Comments

@RNHTTR
Copy link
Collaborator

RNHTTR commented May 15, 2024

What do you see as an issue?

The Contributor's Quick Start is super long and arguably confusing

There are also a handful of issues with the guide now. Here's an example, :

image

Solving the problem

The guide references several different ways to run an Airflow dev environment:

  • Containers with different flavors
    • Docker
    • Colima
    • Docker compose
  • Hatch, pyenv, pyenv-virtualenv, or virtualenvwrapper
  • Postgres (not necessary for a lot of contributions, especially for someone new to contributing here)
  • Breeze

I think we should align on the truly simplest way for users to make their first contribution and move everything else to separate guides.

Anything else

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@RNHTTR RNHTTR added kind:documentation needs-triage label for new issues that we didn't triage yet labels May 15, 2024
@RNHTTR RNHTTR self-assigned this May 15, 2024
@amoghrajesh
Copy link
Contributor

Good catch, I think breeze would be the most ideal dev env setup and also the easiest I'd say

@RNHTTR
Copy link
Collaborator Author

RNHTTR commented May 16, 2024

The downside to breeze is it requires Docker which requires quite a bit of RAM that might make contributing prohibitive to some users. Alternatively there could be a separate quickstart for using a virtual env instead of breeze?

@josh-fell josh-fell removed the needs-triage label for new issues that we didn't triage yet label May 17, 2024
@amoghrajesh
Copy link
Contributor

That's smart. We basically can have 2 quickstarts for two of the most common (and used) developer setups:

  1. Virtual Env Quickstart
  2. Breeze Quickstart

@potiuk
Copy link
Member

potiuk commented May 19, 2024

Yes. I think quick start tried to combine both Breeze and venv setup as quick start, but splitting it to ven e and breeze quick start is a good idea. Both serve different purpose - there is even a table in contributing docs when you should use local venv and when Breeze

@potiuk
Copy link
Member

potiuk commented May 19, 2024

We discussed very similar thing about generic Python experience and it would be great to have a page in our contribute docs 'if you want to do this - choose local',of you want to do that - setup Breeze.

@RNHTTR RNHTTR linked a pull request May 25, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants