Browse Source

docs(readme): fix headings [skip ci]

pull/28/head
Imran Iqbal 3 years ago
parent
commit
99b4c293f8
No account linked to committer's email address
1 changed files with 2 additions and 4 deletions
  1. +2
    -4
      docs/README.rst

+ 2
- 4
docs/README.rst View File

.. _readme:

syslog-ng-formula syslog-ng-formula
================= =================


Installs and configures the syslog_ng package. Installs and configures the syslog_ng package.


``syslog_ng.package`` ``syslog_ng.package``
^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^
Installs the syslog_ng package and optional packages which may provide additional functionalities. Installs the syslog_ng package and optional packages which may provide additional functionalities.


``syslog_ng.config`` ``syslog_ng.config``
This state manages the file ``syslog_ng.conf`` under ``/etc/syslog-ng`` (template found in "syslog_ng/files"). The configuration is populated by values in "syslog_ng/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar. This state manages the file ``syslog_ng.conf`` under ``/etc/syslog-ng`` (template found in "syslog_ng/files"). The configuration is populated by values in "syslog_ng/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.


``syslog_ng.service`` ``syslog_ng.service``
^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^
Manages the startup and running state of the syslog_ng service. Manages the startup and running state of the syslog_ng service.


Testing Testing

Loading…
Cancel
Save