Open noelmcloughlin opened 4 years ago
I agree that we should provide a better way to distinguish between meta and sub states and separate components. Maybe using the order in which they are called?
For example:
template
template.subcomponent
template.subcomponent.clean
template.clean
template.package
template.config
template.service
template.subcomponent.config
template.subcomponent.config.clean
template.service.clean
template.config.clean
template.package.clean
I think that if we have more than one configuration file, we should consider template.config
as a meta-state and each individual file as sub-state, for example:
template.config
template.config.configfile1
template.config.configfile2
Substates are really useful for advanced users needing granularity, or building a solution needing to call one substate (i.e.setup a repository) without forcing entire formula on them.
Since many software has official API the sub-states can match API calls. See lvm-formula
and devstack-formula.cli
states for example - the API = SUB-STATES.
Related to this is https://github.com/saltstack-formulas/template-formula/pull/136 since there is duplication of states when the README is generated.
Available Meta states
...
Available substates
@baby-gnu While reviewing the lvm-formula
PR, I'd like to suggest a minor adjustment to these headings:
-Available Meta states
+Available meta-states
...
-Available substates
+Available sub-states
@myii I completely agree, this was just a proposal for discussion.
Thanks.
@baby-gnu You're welcome, thanks for the feedback.
I would recommend "Available States" section in README is split.
See example at https://github.com/saltstack-formulas/lvm-formula#available-meta-states