Variable documentation

[4t1l4]

Proposed Changes

• Add variable documentation.

Closes #560

Checklist

• Tested locally
• Ran site.yml playbook
• Ran reset.yml playbook
• Did not add any unnecessary changes
• Ran pre-commit install at least once before committing
• 🚀

[4t1l4]

Hi, this is still WIP, but I'd appreciate some early feedback.

The table in the main README is starting to get big, the horizontal scroll is not great. There are a few ways to go about this but I'm not sure which would be best so anything maintainers like is good to me.

I'm trying to keep the descriptions as they are in the argument_specs and only adding things where there's a choices argument or where there was no description, because I'm using ansible-doc to help me do this and it doesn't like it when an option or sub-option doesn't have one.

[timothystewart6]

@4t1l4 wow! This looks great! I am sure everyone will appreciate this contribution!

[4t1l4]

OK, ready for review now. Happy to adapt anything to make things easier to read or better structured. I'm very glad there's no MD linting in the hooks because that table would need a lot of tinkering with to fit the usual standards (I'd just stick some HTML instead if I had to).

[4t1l4]

On a side note:

I noticed that some of the default values for 3rd party stuff (version tags) will get stale soon. I looked into those defaults in the roles and don't see any dependabot config there to manage it. I'm used to sticking custom regex with Renovate, but don't know if this is possible with dependabot. Happy to work on that on a separate PR so we get automated dep updates both in the code and the docs.

[timothystewart6]

@4t1l4 thank you! That would be awesome if you could figure out the regex for the container tags that are specified in k3s-ansible/inventory/sample/group_vars/all.yml

[4t1l4]

I created #608 for the dependency management stuff.