Document Variables

[timothystewart6]

We should document variables and how to use them. Something as simple as an MD table in README.md would be nice but am open to other ideas.

Variable	Default	Required	Description
k3s_version	none	yes	The version of k3s to use
ansible_user	none	yes	The ansible user that will be used

etc...

[ednxzu]

Wild tangent here: but an mkdocs-material (or equivalent) static docs website for it ? coming from openstack, something like this is really nice to read along when deploying.

using the wiki feature of github might also be an option, although I am not familiar with it, it could be a nice way to add bigger, more detailed documentation directly to the project ?

[timothystewart6]

Thanks! I am open to it however I think first documenting it in the README is the path of least resistance. It would also allow those making changes to update the corresponding documentation.

[Raytle]

It's not a wild tangent, but it is wishful thinking.

Solo FOSS devs are usually building something for fun and/or trying to solve a problem they care about. Writing detailed documentation isn’t something they usually enjoy, therefore they often don't give it much attention.

By the way, based on a few hours of research I did a few week ago, Astro Starlight>Docusaurus>MkDocs