ci(pre-commit): finalise `rstcheck` configuration [skip ci]
* Automated using https://github.com/myii/ssf-formula/pull/267
This commit is contained in:
parent
d4460718c5
commit
22fa616f59
|
@ -52,4 +52,5 @@ repos:
|
||||||
hooks:
|
hooks:
|
||||||
- id: rstcheck
|
- id: rstcheck
|
||||||
name: Check reST files using rstcheck
|
name: Check reST files using rstcheck
|
||||||
|
exclude: 'docs/CHANGELOG.rst'
|
||||||
args: [--report=warning]
|
args: [--report=warning]
|
||||||
|
|
|
@ -64,7 +64,7 @@ Example: NTP before applying TOFS
|
||||||
|
|
||||||
Let's work with the NTP example. A basic formula that follows the `design guidelines <http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_ has the following files and directories tree:
|
Let's work with the NTP example. A basic formula that follows the `design guidelines <http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_ has the following files and directories tree:
|
||||||
|
|
||||||
.. code-block::
|
.. code-block:: console
|
||||||
|
|
||||||
/srv/saltstack/salt-formulas/ntp-saltstack-formula/
|
/srv/saltstack/salt-formulas/ntp-saltstack-formula/
|
||||||
ntp/
|
ntp/
|
||||||
|
@ -226,7 +226,7 @@ We can make different templates coexist for different minions, classified by any
|
||||||
|
|
||||||
If we decide that we want ``os_family`` as switch, then we could provide the formula template variants for both the ``RedHat`` and ``Debian`` families.
|
If we decide that we want ``os_family`` as switch, then we could provide the formula template variants for both the ``RedHat`` and ``Debian`` families.
|
||||||
|
|
||||||
.. code-block::
|
.. code-block:: console
|
||||||
|
|
||||||
/srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/
|
/srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/
|
||||||
default/
|
default/
|
||||||
|
@ -449,7 +449,7 @@ Using sub-directories for ``components``
|
||||||
|
|
||||||
If your formula is composed of several components, you may prefer to provides files under sub-directories, like in the `systemd-formula <https://github.com/saltstack-formulas/systemd-formula>`_.
|
If your formula is composed of several components, you may prefer to provides files under sub-directories, like in the `systemd-formula <https://github.com/saltstack-formulas/systemd-formula>`_.
|
||||||
|
|
||||||
.. code-block::
|
.. code-block:: console
|
||||||
|
|
||||||
/srv/saltstack/systemd-formula/
|
/srv/saltstack/systemd-formula/
|
||||||
systemd/
|
systemd/
|
||||||
|
|
Loading…
Reference in New Issue