over the time, Foreman gathered a lot of template parameters. I am starting an attempt to document them all and mark those which can be deprecated (e.g. same functionality under different names or template types - debian vs redhat).
I need your help! I can probably document all the bare-metal provisioning related, however we have many more, plugins and bunch of katello-related stuff. Please spend a minute and review this list and fill description for those you know what they do! Thank you.
I will be taking this list and turning it into a YAML so Foreman would actually check for description presence. Something like this (rough proposal):
--- # # Documentation for template parameters. Rules when editing: # # * Prefer lower-case-dash-separated parameter names. # * Keep description short and on point. # * Try to keep the list sorted # 00_example_parameter: description: 'Brief description. Can be multiple sentences but no newlines.' context: 'Where it can be used (e.g. Kickstart, Remote execution).' deprecated: true
From here, this could be easily transformed into our documentation or even used within Foreman application to show on template edit page. Heck we could even do parameter competition in the edit component if we have spare cycles
Foreman is a beast, let’s help our users to find what they need.