Document user configurable settings #1788
Conversation
Automated comment from CodeApprove ➜⏳ @jotaen4tinypilot please review this Pull Request |
There was a problem hiding this comment.
Automated comment from CodeApprove ➜
In: Discussion
Is there anything from the documentation that we had in the Ansible roles that would be worth to take over? (E.g., see the archived uStreamer Ansible defaults/main.yml.
I’m thinking, we probably don’t have to repeat documentation that we already have elsewhere, but some of the values might not be immediately obvious (e.g. tinypilot_manage_tls_keys or tinypilot_keyboard_interface). One thought would be to just take over whatever commentary we had, to make it a bit more discoverable; or we could link/refer to the archived Ansible repos?
👀 @jdeanwallace it's your turn please take a look
There was a problem hiding this comment.
Automated comment from CodeApprove ➜
In: Discussion
I would probably avoid referencing the respective ansible role repos because there was a stage where we consolidated them into the main tinypilot repo, so I'm not sure what changes were made to the roles since that happened. So my thinking was that the most recent version of the ansible roles were the ansible-role/ and ansible-role-ustreamer/ directories in the tinypilot 2.6.0 (i.e., our last TinyPilot version that used Ansible).
One thought would be to just take over whatever commentary we had, to make it a bit more discoverable
Yeah I think it makes sense to preserve those comments by copying them into this document seeing as Ansible is no more. I only did this for supported and deprecated settings.
👀 @jotaen4tinypilot it's your turn please take a look
There was a problem hiding this comment.
Automated comment from CodeApprove ➜
✔️ Approved
In: Discussion
Cool, that makes sense to me!
👀 @jdeanwallace it's your turn please take a look
Resolves #1573
Since winning the war on Ansible, we've dropped support for many TinyPilot settings that were configurable via
/home/tinypilot/settings.yml.Apart from this blog post (/whats-new-in-2022-05/) we haven't really documented (publicly) which settings are supported, deprecated, and unsupported. This PR does just that:
Notes
Resources used