tinypilot
tinypilot copied to clipboard
tiny-pilot
Documentation for update mechanism
Resolves https://github.com/tiny-pilot/tinypilot/issues/1007.
Note (July 30th)
As mentioned in the ticket, I started to think about the documentation for the update mechanism:
- This PR contains an outline of the aspects I think would be worth capturing. For now, I only set up the headlines/sections, wrote a few short sentences, and set up some bullet points to get the idea across. If we are happy with scope and structure, I’d phrase things properly and accurately. (I hope it’s not too rough and confusing, I just wanted to briefly check-in actually…)
- I would only create a single instance of the documentation that covers things for both Community and Pro. (As opposed to covering the Pro-specific aspects only in the Pro repo.)
- For gatekeeper, I think we could elaborate a bit more in the gatekeeper Readme, e.g. to give an overview how it integrates with Backblaze (e.g. the “special files” and our internal folder structure). Other than that, the project feels fairly self-explanatory for me, because of the code structure and comments.
- I’d also briefly summarize the legacy update flow. It might be that in 3 years some user files a bug ticket, because they updated their device from 2020 for the first time, and it might not be immediately obvious to future devs that the update mechanism used to work differently back then. I’d also add some “historic” references, e.g. to the overhaul document or to the mega ticket.
This is still on my radar. I was hoping to get it done while you were on vacation, but I'm still slammed with the hiring process for the support engineer role.
This is still on my radar. I was hoping to get it done while you were on vacation, but I'm still slammed with the hiring process for the support engineer role.
No worries, it’s not urgent and I’m not blocked.
Strange – the PR still shows up as “unapproved”. @mtlynch could you try to approve again, please? Maybe that somehow gets it unstuck 🤔
vs
