Improve Docs (focusing on local development)

[dimitropoulos]

This is a draft pull request for some miscellaneous blips and bloops found while getting started with local development.

[dimitropoulos]

@stefanprodan thanks for the approval! it's one of those new/fancy draft pull requests, meaning I'm going to keep it open for a little bit (as a work-in-progress PR might) and add to it as I find things to add. I suspect that will include some changes to the building file to say a little more about the development workflow.

[rade]

I'm going to keep it open for a little bit

Does the PR as it stands improve on the status quo? If so, merge it!

[dimitropoulos]

@rade I catch your drift (and the answer is yes) but the thing I'm trying to avoid is to have to go through the branch creation - pull request - review - merge cycle for every individual commit (not that you're suggesting to go that granular, but in fairness, there's almost nothing of substance yet in this PR). I expect to have this merged by the end of the week and I don't want to spend time creating pull requests when I could spend that same time coding. if the trade-off of that is such that it will take a few extra days for these things to land on master then I think that's an acceptable trade-off.

[dimitropoulos]

but more generally @stefanprodan @squaremo if you would like me to merge it, just let me know and I'm happy to push up another PR at the end of the week. I'm actually surprised to find that it's possible to review (or approve) a draft PR before I've signaled that it's "Ready for review". here is what it looks like on my end:

[dholbach]

Thanks for your work on this! A small suggestion, I'll leave it up to you if you want to make the change.

[stefanprodan]

Can you please replace Freshpod with Skaffold, Freshpod is no longer maintained.

[dimitropoulos]

Yes. @squaremo had suggested I used freshpod. That, and it being super easy (with the one-liner) to integrate was the reason for using it.

[dholbach]

Minor: Probably doesn't need the 1. as it's just one step.

[dholbach]

[ This is about site/get-started-developing.md ... ]

Thanks @dimitropoulos for your work on this. It reads well, goes into detail, but not into too much detail.

The last paragraph under "Make Some Changes" is written a bit colloquially ("the Kubernetes api server [..] will go ..."), which is different in style from any other of the flux docs, but I feel that's fine.

As I'm not regularly hacking on Flux, I'd recommend to also ask @squaremo @hiddeco @2opremio or @stefanprodan for input. Maybe we can even agree on the tools we use for development? :-D

[dimitropoulos]

Maybe we can even agree on the tools we use for development? :-D

That is the current issue. @stefanprodan has rightly pointed out that it's not super-duper responsible to put freshpod in here since it's on its way to the grave (with skaffold as the official successor). The problem is that it's very much still supported by minikube and does what it does well at the same time as being stupidly-simple to configure (just minikube addons enable freshpod and that's it). All the same, I'm trying my hand at getting skaffold going in place of freshpod.

[rade]

freshpod vs skaffold

I wouldn't hold up this PR for that. Go with freshpod and change the recommendation to skaffold once that has been shown to work well.

[dimitropoulos]

ok. will do.

[squaremo]

Thanks for sticking at this @dimitropoulos 🍱