search

infinyon / fluvio

Lean and mean distributed stream processing system written in rust and web assembly.
https://www.fluvio.io/
Apache License 2.0
2.77k stars 198 forks source link

chore(docs): update `DEVELOPER.md` #4070

Closed EstebanBorai closed 2 weeks ago

EstebanBorai commented 2 weeks ago

Updates DEVELOPER guide with most recent changes on how to run Fluvio for development, as well as taking advantage of formatting improvements offered by GitHub such as annotations, callouts and keyboard markdown.

Split command examples so users can copy the command without including the output.

Screenshot 2024-06-18 at 11 13 30 AM

Here is a rendered version: https://github.com/infinyon/fluvio/blob/chore/developer-md/DEVELOPER.md#inlining-helm-chart

EstebanBorai commented 2 weeks ago

@digikata good catch! Im updating the version prints on d4b3b69

EstebanBorai commented 2 weeks ago

nice job.

given that local cluster development should be primary path, move all k8 stuff to separate section or in another doc. that way, dev doesn't need to deal with unless they are interested.

Agree! Nice idea!

EstebanBorai commented 2 weeks ago

@sehz @digikata I think we can rely on the Outline button provided by GitHub so we dont have to maintain the index at the beginning of the file?

https://github.com/infinyon/fluvio/blob/b76da9fdbd30ef5f0ce4f2f2c1cf7eada6a35213/DEVELOPER.md?plain=1#L4-L35

Here is how it looks:

Screenshot 2024-06-18 at 12 39 40 PM