Skip to content

Commit

Permalink
docs(readme): describe the new “template.subcomponent” states
Browse files Browse the repository at this point in the history
The subcomponent only provides a configuration file and its cleaning
state.
  • Loading branch information
baby-gnu committed Jul 30, 2019
1 parent fd55e03 commit 6b595cd
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,28 @@ dependency on ``template.service.clean`` via include list.
This state will remove the template package and has a depency on
``template.config.clean`` via include list.

``template.subcomponent``
^^^^^^^^^^^^^^^^^^^^^^^^^

*Meta-state (This is a state that includes other states)*.

This state installs a subcomponent configuration file before
configuring and starting the template service.

``template.subcomponent.config``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will configure the template subcomponent and has a
dependency on ``template.config`` via include list.

``template.subcomponent.config.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove the configuration of the template subcomponent
and reload the template service by a dependency on
``template.service.running`` via include list and ``watch_in``
requisite.

Testing
-------

Expand Down

0 comments on commit 6b595cd

Please sign in to comment.