From 3c0de53a6fb8fdc680d009abf07a8ec9cc890e2d Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Thu, 25 May 2023 17:16:04 +0200 Subject: [PATCH] Add a bit more documentation --- docs/playbooks.md | 8 ++++++++ docs/scripts.md | 20 ++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/playbooks.md create mode 100644 docs/scripts.md diff --git a/docs/playbooks.md b/docs/playbooks.md new file mode 100644 index 0000000..6c3c7b3 --- /dev/null +++ b/docs/playbooks.md @@ -0,0 +1,8 @@ +# Ansible Boilerplate Collection Playbooks + +The Ansible Boilerplate Collection provides some playbooks which can be used by +dependant projects. Those playbooks are stored in the `playbooks/` directory. + +## "ping" Play + +Run the Ansible "ping" module. diff --git a/docs/scripts.md b/docs/scripts.md new file mode 100644 index 0000000..ac0d43b --- /dev/null +++ b/docs/scripts.md @@ -0,0 +1,20 @@ +# Ansible Boilerplate Collection Scripts + +The Ansible Boilerplate Collection contains some scripts which are stored in the +`bin/` directory, in the project itself as well as in projects using the +Boilerplate Collection. + +## "ansible-boilerplate" Script + +Management script for the Ansible Boilerplate Collection itself. Used to +initialize new projects as well as upgrading (activating) dependent projects +using this collection. + +## "a" Wrapper Script for "ansible" Command + +Wrapper for the `ansible` command. + +## "ap" and "aps" Wrapper Scripts for "ansible-playbook" Command + +The `ap` script is a wrapper for the `ansible-playbook` command. The `aps` +script uses the `ap` command and runs it with the "site play". -- 2.39.2