Browse Source

ci(pre-commit): finalise `rstcheck` configuration [skip ci]

* Automated using https://github.com/myii/ssf-formula/pull/267
tags/v1.0.1
Imran Iqbal 4 years ago
parent
commit
1c2125c251
No account linked to committer's email address
2 changed files with 10 additions and 3 deletions
  1. +7
    -0
      .pre-commit-config.yaml
  2. +3
    -3
      docs/TOFS_pattern.rst

+ 7
- 0
.pre-commit-config.yaml View File

- id: salt-lint - id: salt-lint
name: Check Salt files using salt-lint name: Check Salt files using salt-lint
files: ^.*\.(sls|jinja|j2|tmpl|tst)$ files: ^.*\.(sls|jinja|j2|tmpl|tst)$
- repo: https://github.com/myint/rstcheck
rev: 3f929574
hooks:
- id: rstcheck
name: Check reST files using rstcheck
exclude: 'docs/CHANGELOG.rst'
args: [--report=warning]

+ 3
- 3
docs/TOFS_pattern.rst View File



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/


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/


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…
Cancel
Save