tiny-pilot / tinypilot

Use your Raspberry Pi as a browser-based KVM.
https://tinypilotkvm.com
MIT License
2.89k stars 244 forks source link

Backport documentation updates from TinyPilot Pro #1738

Closed jotaen4tinypilot closed 5 months ago

jotaen4tinypilot commented 5 months ago

While reviewing https://github.com/tiny-pilot/tinypilot/pull/1736, I noticed that the CONTRIBUTING doc differs between Community and Pro.

I believe that we accidentally updated the Pro doc, where we meant to update the Community one instead. (We actually even cover Community in the new text, see L165.)

The respective changes originally came from https://github.com/tiny-pilot/tinypilot-pro/pull/985/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055, when we faded out Ansible. I’ve copy&pasted everything over verbatim, except for the (now-invalidated) PicoShare URL, which I’ve swapped in favour of a Wiki page.

Review on CodeApprove

mtlynch commented 5 months ago

I think (b) is a pretty good solution. It's less convenient, but you can just get the link once and bookmark it. Once you've done the workflow once or twice, it's pretty easy to remember, so it's not like you'd have to go and step through the instructions each time.

(a) I think is fine too, but is a little bit more error-prone.

(c) I'd like to avoid as part of minimizing the workflows that depend on me.