Hi list,
I'd like to open a discussion about "description" parameter.
Ansible does nothing about on it. It just describing what is it.
I know YAML can have a comment and name is good to know what this task
do. But comment is not structured and name can not be long because
handlers use it.
If ansible defines "description", some documentation tool like Sphinx
[1] can read it and produces a good document.
---
- hosts: all
description: This playbook is an example for describe parameter
tasks:
- name: create empty file
file: path=/tmp/empty state=touch
description: >
This empty file is needed to later tasks,
such as A, B, and C. so we have to do blah blah blah
- name: do some script
script: /some/local/script.sh
description:
- a
- b
- c
- script: /some/local/script.sh
description:
can: use map
some: thing
other: thing
- include: other.yml
description:
- include can have description also
I have made PR which make very small change.
https://github.com/ansible/ansible/pull/9230
Thanks for your feedback.
[1] Sphinx: http://sphinx-doc.org/
WAKAYAMA Shirou
--
You received this message because you are subscribed to the Google Groups
"Ansible Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/ansible-project/CANCK7Kf%3Dciuy8FNnfFqb8DapmdfqFH8UWUqeMFA6VAwbBjoZTQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
