psi-jack/formula-sudoers
1
0
Fork 0
mirror of synced 2024-11-24 17:55:36 -05:00
Code Issues Releases Wiki Activity

docs: fix CONTRIBUTING and README

Browse source 
* Finalises comments from #51
This commit is contained in:
Imran Iqbal 2019-05-29 19:50:49 +01:00
parent 4fb086a88c
commit d60487643e
No known key found for this signature in database
GPG key ID: 6D8629439D2B7819
4 changed files with 6 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
FORMULA
View file

@ -5,5 +5,5 @@ version: 1.0.0rc
release: 1 release: 1
minimum_version: 2016.11 minimum_version: 2016.11
summary: Sudoers formula summary: Sudoers formula
description: Formula to configure sudo description: Formula to configure sudo and the sudoers included files
top_level_dir: sudoers top_level_dir: sudoers

28
docs/CONTRIBUTING.rst
View file

@ -156,31 +156,3 @@ An example of that:
BREAKING CHANGE: With the removal of all of the `.sls` files under BREAKING CHANGE: With the removal of all of the `.sls` files under
`template package`, this formula no longer supports the installation of `template package`, this formula no longer supports the installation of
packages. 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>`_

5
docs/README.rst
View file

@ -14,8 +14,7 @@ sudoers-formula
:scale: 100% :scale: 100%
:target: https://github.com/semantic-release/semantic-release :target: https://github.com/semantic-release/semantic-release
A SaltStack formula that is empty. It has dummy content to help with a quick Set up ``sudo`` and the ``sudoers`` included files.
start on a new formula and it serves as a style guide.
.. contents:: **Table of Contents** .. contents:: **Table of Contents**
@ -80,7 +79,7 @@ e.g. ``debian-9-2019-2-py3``.
``bin/kitchen converge`` ``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`` ``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^

3
pillar.example
View file

@ -1,3 +1,6 @@
# -*- coding: utf-8 -*-
# vim: ft=yaml
---
sudoers: sudoers:
# By default the main sudoers file is managed by this formula (False to skip) # By default the main sudoers file is managed by this formula (False to skip)
manage_main_config: True manage_main_config: True