From d60487643ea197038f8d36014d0c9c2aeda997e0 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 29 May 2019 19:50:49 +0100 Subject: [PATCH] docs: fix `CONTRIBUTING` and `README` * Finalises comments from #51 --- FORMULA | 2 +- docs/CONTRIBUTING.rst | 28 ---------------------------- docs/README.rst | 5 ++--- pillar.example | 3 +++ 4 files changed, 6 insertions(+), 32 deletions(-) diff --git a/FORMULA b/FORMULA index 6f770f8..dc72520 100644 --- a/FORMULA +++ b/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 diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 1179c5a..5da9ae8 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -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 `_ -* `cert-formula `_ -* `chrony-formula `_ -* `collectd-formula `_ -* `fail2ban-formula `_ -* `keepalived-formula `_ -* `nginx-formula `_ -* `postgres-formula `_ -* `prometheus-formula `_ -* `rkhunter-formula `_ -* `salt-formula `_ -* `syslog-ng-formula `_ -* `systemd-formula `_ -* `ufw-formula `_ -* `vault-formula `_ - - -Documentation -------------- - -`Documentation contributing guidelines `_ diff --git a/docs/README.rst b/docs/README.rst index 95bad14..a5a81d6 100644 --- a/docs/README.rst +++ b/docs/README.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`` ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/pillar.example b/pillar.example index bc7e856..2383218 100644 --- a/pillar.example +++ b/pillar.example @@ -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