From 46d62a4f61b3f8dae823fb8a69d8466a2566e45d Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Thu, 31 Dec 2020 14:50:42 +0100 Subject: [PATCH] docs: update demo-role example [skip ci] --- example/README.md | 76 +++++++++++++++++++++++------------------------ 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/example/README.md b/example/README.md index 463ea7f..30a3330 100644 --- a/example/README.md +++ b/example/README.md @@ -8,13 +8,13 @@ Role to demonstrate ansible-doctor. It is also possible to overwrite the default ## Table of content * [Default Variables](#default-variables) - * [demo_role_unset](#demo_role_unset) + * [demo_role_dict](#demo_role_dict) * [demo_role_empty](#demo_role_empty) - * [demo_role_single](#demo_role_single) * [demo_role_empty_dict](#demo_role_empty_dict) - * [demo_role_dict](#demo_role_dict) * [demo_role_other_tags](#demo_role_other_tags) + * [demo_role_single](#demo_role_single) * [demo_role_undefined_var](#demo_role_undefined_var) + * [demo_role_unset](#demo_role_unset) * [Dependencies](#dependencies) * [License](#license) * [Author](#author) @@ -23,20 +23,26 @@ Role to demonstrate ansible-doctor. It is also possible to overwrite the default ## Default Variables -### demo_role_unset - -You can set values as string, but there is no magic or autoformatting... +### demo_role_dict #### Default value ```YAML -demo_role_unset: +demo_role_dict: + key1: + sub: some value ``` #### Example usage ```YAML -demo_role_unset: some_value +demo_role_dict: + key1: + sub: some value + key2: + sublist: + - subval1 + - subval2 ``` ### demo_role_empty @@ -47,14 +53,6 @@ demo_role_unset: some_value demo_role_empty: '' ``` -### demo_role_single - -#### Default value - -```YAML -demo_role_single: b -``` - ### demo_role_empty_dict ... or you can use a valid json. In this case, the json will be automatically prefixed with the annotation key and you can use e.g. `to_nice_yaml` filter in your templates. To get this working, you have to prefix your json with a `$` char. @@ -77,28 +75,6 @@ demo_role_empty_dict: - subval2 ``` -### demo_role_dict - -#### Default value - -```YAML -demo_role_dict: - key1: - sub: some value -``` - -#### Example usage - -```YAML -demo_role_dict: - key1: - sub: some value - key2: - sublist: - - subval1 - - subval2 -``` - ### demo_role_other_tags If a variable need some more explanation, this is a good place to do so. @@ -117,6 +93,14 @@ demo_role_other_tags: - package2 ``` +### demo_role_single + +#### Default value + +```YAML +demo_role_single: b +``` + ### demo_role_undefined_var If you want to add an explicit notice, that a var is not set by default, this is one option. Make sure to flag it as json value: `@var demo_role_undefined_var: $ "_unset_"` @@ -127,6 +111,22 @@ If you want to add an explicit notice, that a var is not set by default, this is demo_role_undefined_var: _unset_ ``` +### demo_role_unset + +You can set values as string, but there is no magic or autoformatting... + +#### Default value + +```YAML +demo_role_unset: +``` + +#### Example usage + +```YAML +demo_role_unset: some_value +``` + ## Dependencies None.