Merge pull request #52 from myii/docs/fix-contributing
docs: fix `CONTRIBUTING` and `README`
This commit is contained in:
commit
ce282bc518
2
FORMULA
2
FORMULA
|
@ -5,5 +5,5 @@ version: 1.0.0rc
|
|||
release: 1
|
||||
minimum_version: 2016.11
|
||||
summary: Sudoers formula
|
||||
description: Formula to configure sudo
|
||||
description: Formula to configure sudo and the sudoers included files
|
||||
top_level_dir: sudoers
|
||||
|
|
|
@ -156,31 +156,3 @@ An example of that:
|
|||
BREAKING CHANGE: With the removal of all of the `.sls` files under
|
||||
`template package`, this formula no longer supports the installation of
|
||||
packages.
|
||||
|
||||
|
||||
Semantic release formulas
|
||||
-------------------------
|
||||
|
||||
These formulas are already compatible with semantic-release:
|
||||
|
||||
* `bind-formula <https://github.com/saltstack-formulas/bind-formula>`_
|
||||
* `cert-formula <https://github.com/saltstack-formulas/cert-formula>`_
|
||||
* `chrony-formula <https://github.com/saltstack-formulas/chrony-formula>`_
|
||||
* `collectd-formula <https://github.com/saltstack-formulas/collectd-formula>`_
|
||||
* `fail2ban-formula <https://github.com/saltstack-formulas/fail2ban-formula>`_
|
||||
* `keepalived-formula <https://github.com/saltstack-formulas/keepalived-formula>`_
|
||||
* `nginx-formula <https://github.com/saltstack-formulas/nginx-formula>`_
|
||||
* `postgres-formula <https://github.com/saltstack-formulas/postgres-formula>`_
|
||||
* `prometheus-formula <https://github.com/saltstack-formulas/prometheus-formula>`_
|
||||
* `rkhunter-formula <https://github.com/saltstack-formulas/rkhunter-formula>`_
|
||||
* `salt-formula <https://github.com/saltstack-formulas/salt-formula>`_
|
||||
* `syslog-ng-formula <https://github.com/saltstack-formulas/syslog-ng-formula>`_
|
||||
* `systemd-formula <https://github.com/saltstack-formulas/systemd-formula>`_
|
||||
* `ufw-formula <https://github.com/saltstack-formulas/ufw-formula>`_
|
||||
* `vault-formula <https://github.com/saltstack-formulas/vault-formula>`_
|
||||
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
`Documentation contributing guidelines <CONTRIBUTING_DOCS.rst>`_
|
||||
|
|
|
@ -14,8 +14,7 @@ sudoers-formula
|
|||
:scale: 100%
|
||||
:target: https://github.com/semantic-release/semantic-release
|
||||
|
||||
A SaltStack formula that is empty. It has dummy content to help with a quick
|
||||
start on a new formula and it serves as a style guide.
|
||||
Set up ``sudo`` and the ``sudoers`` included files.
|
||||
|
||||
.. contents:: **Table of Contents**
|
||||
|
||||
|
@ -80,7 +79,7 @@ e.g. ``debian-9-2019-2-py3``.
|
|||
``bin/kitchen converge``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Creates the docker instance and runs the ``template`` main state, ready for testing.
|
||||
Creates the docker instance and runs the ``sudoers`` main state, ready for testing.
|
||||
|
||||
``bin/kitchen verify``
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# vim: ft=yaml
|
||||
---
|
||||
sudoers:
|
||||
# By default the main sudoers file is managed by this formula (False to skip)
|
||||
manage_main_config: True
|
||||
|
|
Loading…
Reference in New Issue