owid / owid-grapher

A platform for creating interactive data visualizations
https://ourworldindata.org
MIT License
1.35k stars 227 forks source link

garden: Improve TMux/make.up commands #3636

Open toni-sharpe opened 1 month ago

toni-sharpe commented 1 month ago

Thinking from the perspective of an open source contributor, perhaps with less experience, and wanting to make things like TMux/Docker pain free. Some input from those with better code knowledge might see issues with the change, maybe I missed an instruction or somesuch. I am also a Sublime Text user, as it happens, I note some instructions are VSCode-centric.

Current master

The contributor gets stuck with a duplicate session error when things are broken by something (some error, closing and re-opening tab). DBeaver showing things are broken. They can fix things with some investigation or they could be time constrained/inexperienced/imposter syndrome/etc. and leave.

https://github.com/owid/owid-grapher/assets/10499070/be1e0055-3036-4047-a2a5-3a7a72542712

Screenshot 2024-05-23 at 00 24 41

With change

The user just needs to run make up twice rather than getting stuck with a duplicate session. DBeaver showing the DB. Things like errors in the UI about TS disappear, and UI refreshes.

https://github.com/owid/owid-grapher/assets/10499070/1e81f99f-9422-4b84-aef3-4ba065412f25

Screenshot 2024-05-23 at 00 40 18

Closing TMux terminal window (likely) with PR change applied

https://github.com/owid/owid-grapher/assets/10499070/eec37dac-94e7-4bd6-b4a2-b6e843c47418

Also sees DB and UI refresh nicely.

Finally, changes make the "waiting for MySQL" TMux screen give clearer output for new devs

Screenshot 2024-06-18 at 09 49 18
github-actions[bot] commented 3 weeks ago

This PR has had no activity within the last two weeks. It is considered stale and will be closed in 3 days if no further activity is detected.

toni-sharpe commented 2 weeks ago

@danyx23 just pinging you as principle here, and I pinged Lars a lot

I feel this makes it a bit easier for new open source folk, it should be as smooth as possible for them.

Maybe there's a better way of acheiving the same

toni-sharpe commented 2 weeks ago

Possibly fixes:

https://github.com/owid/owid-grapher/discussions/3075 https://github.com/owid/owid-grapher/discussions/3122

And this maybe:

https://github.com/owid/owid-grapher/discussions/1963