From 0bea0906f918fc4ceb6e8fa3efe9e568d95061da Mon Sep 17 00:00:00 2001 From: Robert de Bock Date: Sat, 5 Jan 2019 21:52:36 +0000 Subject: [PATCH] Update the description of the role. --- README.md | 18 ++++++++++++------ meta/main.yml | 2 +- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7b22faf..bd56b37 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ dovecot [![Build Status](https://travis-ci.org/robertdebock/ansible-role-dovecot.svg?branch=master)](https://travis-ci.org/robertdebock/ansible-role-dovecot) -The purpose of this role is to install and configure dovecot on your system. +Install and configure dovecot on your system. Example Playbook ---------------- This example is taken from `molecule/default/playbook.yml`: -``` +```yaml --- - name: Converge hosts: all @@ -26,7 +26,7 @@ Role Variables -------------- These variables are set in `defaults/main.yml`: -``` +```yaml --- # defaults file for dovecot @@ -51,9 +51,11 @@ Requirements The following roles can be installed to ensure all requirements are met, using `ansible-galaxy install -r requirements.yml`: +```yaml --- - robertdebock.bootstrap +``` Context ------- @@ -107,9 +109,13 @@ To test on Amazon EC2, configure [~/.aws/credentials](https://docs.aws.amazon.co There are many specific scenarios available, please have a look in the `molecule/` directory. Run the [ansible-galaxy](https://github.com/ansible/galaxy-lint-rules) and [my](https://github.com/robertdebock/ansible-lint-rules) lint rules if you want your change to be merges: -``` -ansible-lint -r /path/to/galaxy-lint-rules/rules . -ansible-lint -r /path/to/ansible-lint-rules/rules . + +```shell +git clone https://github.com/ansible/ansible-lint.git /tmp/ansible-lint +ansible-lint -r /tmp/ansible-lint/lib/ansiblelint/rules . + +git clone https://github.com/robertdebock/ansible-lint /tmp/my-ansible-lint +ansible-lint -r /tmp/my-ansible-lint/rules . ``` License diff --git a/meta/main.yml b/meta/main.yml index 1ab4de6..ba27da8 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -2,7 +2,7 @@ galaxy_info: author: Robert de Bock role_name: dovecot - description: The purpose of this role is to install and configure dovecot on your system. + description: Install and configure dovecot on your system. license: Apache-2.0 company: none min_ansible_version: 2.6