Fix Ansible documentation in part of example formatting. Part 1 (#332)

* Fix Ansible documentation in part of example formatting

* Fix

plugins/modules/database/misc/elasticsearch_plugin.py

@@ -74,28 +74,28 @@ options:
 '''
 
 EXAMPLES = '''
-# Install Elasticsearch Head plugin in Elasticsearch 2.x
-- elasticsearch_plugin:
+- name: Install Elasticsearch Head plugin in Elasticsearch 2.x
+  elasticsearch_plugin:
     name: mobz/elasticsearch-head
     state: present
 
-# Install a specific version of Elasticsearch Head in Elasticsearch 2.x
-- elasticsearch_plugin:
+- name: Install a specific version of Elasticsearch Head in Elasticsearch 2.x
+  elasticsearch_plugin:
     name: mobz/elasticsearch-head
     version: 2.0.0
 
-# Uninstall Elasticsearch head plugin in Elasticsearch 2.x
-- elasticsearch_plugin:
+- name: Uninstall Elasticsearch head plugin in Elasticsearch 2.x
+  elasticsearch_plugin:
     name: mobz/elasticsearch-head
     state: absent
 
-# Install a specific plugin in Elasticsearch >= 5.0
-- elasticsearch_plugin:
+- name: Install a specific plugin in Elasticsearch >= 5.0
+  elasticsearch_plugin:
     name: analysis-icu
     state: present
 
-# Install the ingest-geoip plugin with a forced installation
-- elasticsearch_plugin:
+- name: Install the ingest-geoip plugin with a forced installation
+  elasticsearch_plugin:
     name: ingest-geoip
     state: present
     force: yes

plugins/modules/database/misc/riak.py

@@ -54,17 +54,17 @@ options:
 '''
 
 EXAMPLES = '''
-# Join's a Riak node to another node
-- riak:
+- name: "Join's a Riak node to another node"
+  riak:
     command: join
     target_node: riak@10.1.1.1
 
-# Wait for handoffs to finish.  Use with async and poll.
-- riak:
+- name: Wait for handoffs to finish. Use with async and poll.
+  riak:
     wait_for_handoffs: yes
 
-# Wait for riak_kv service to startup
-- riak:
+- name: Wait for riak_kv service to startup
+  riak:
     wait_for_service: kv
 '''
 

plugins/modules/database/mssql/mssql_db.py

@@ -59,17 +59,19 @@ author: Vedit Firat Arig (@vedit)
 '''
 
 EXAMPLES = '''
-# Create a new database with name 'jackdata'
-- mssql_db:
+- name: Create a new database with name 'jackdata'
+  mssql_db:
     name: jackdata
     state: present
 
 # Copy database dump file to remote host and restore it to database 'my_db'
-- copy:
+- name: Copy database dump file to remote host
+  copy:
     src: dump.sql
     dest: /tmp
 
-- mssql_db:
+- name: Restore the dump file to database 'my_db'
+  mssql_db:
     name: my_db
     state: import
     target: /tmp/dump.sql

plugins/modules/database/proxysql/proxysql_backend_servers.py

@@ -99,7 +99,8 @@ EXAMPLES = '''
 # runtime in a single batch using the M(proxysql_manage_config) module).  It
 # uses supplied credentials to connect to the proxysql admin interface.
 
-- proxysql_backend_servers:
+- name: Add a server
+  proxysql_backend_servers:
     login_user: 'admin'
     login_password: 'admin'
     hostname: 'mysql01'
@@ -110,7 +111,8 @@ EXAMPLES = '''
 # dynamically loads the mysql server config to runtime.  It uses credentials
 # in a supplied config file to connect to the proxysql admin interface.
 
-- proxysql_backend_servers:
+- name: Remove a server
+  proxysql_backend_servers:
     config_file: '~/proxysql.cnf'
     hostname: 'mysql02'
     state: absent

plugins/modules/database/proxysql/proxysql_global_variables.py

@@ -37,7 +37,8 @@ EXAMPLES = '''
 # runtime. It uses supplied credentials to connect to the proxysql admin
 # interface.
 
-- proxysql_global_variables:
+- name: Set the value of a variable
+  proxysql_global_variables:
     login_user: 'admin'
     login_password: 'admin'
     variable: 'mysql-max_connections'
@@ -46,7 +47,8 @@ EXAMPLES = '''
 # This example gets the value of a variable.  It uses credentials in a
 # supplied config file to connect to the proxysql admin interface.
 
-- proxysql_global_variables:
+- name: Get the value of a variable
+  proxysql_global_variables:
     config_file: '~/proxysql.cnf'
     variable: 'mysql-default_query_delay'
 '''

plugins/modules/database/proxysql/proxysql_manage_config.py

@@ -61,7 +61,8 @@ EXAMPLES = '''
 # This example saves the mysql users config from memory to disk. It uses
 # supplied credentials to connect to the proxysql admin interface.
 
-- proxysql_manage_config:
+- name: Save the mysql users config from memory to disk
+  proxysql_manage_config:
     login_user: 'admin'
     login_password: 'admin'
     action: "SAVE"
@@ -69,10 +70,11 @@ EXAMPLES = '''
     direction: "FROM"
     config_layer: "MEMORY"
 
-# This example loads the mysql query rules config from memory to to runtime. It
+# This example loads the mysql query rules config from memory to runtime. It
 # uses supplied credentials to connect to the proxysql admin interface.
 
-- proxysql_manage_config:
+- name: Load the mysql query rules config from memory to runtime
+  proxysql_manage_config:
     config_file: '~/proxysql.cnf'
     action: "LOAD"
     config_settings: "MYSQL QUERY RULES"

plugins/modules/database/proxysql/proxysql_mysql_users.py

@@ -94,7 +94,8 @@ EXAMPLES = '''
 # runtime in a single batch using the M(proxysql_manage_config) module).  It
 # uses supplied credentials to connect to the proxysql admin interface.
 
-- proxysql_mysql_users:
+- name: Add a user
+  proxysql_mysql_users:
     login_user: 'admin'
     login_password: 'admin'
     username: 'productiondba'
@@ -105,7 +106,8 @@ EXAMPLES = '''
 # dynamically loads the mysql user config to runtime.  It uses credentials
 # in a supplied config file to connect to the proxysql admin interface.
 
-- proxysql_mysql_users:
+- name: Remove a user
+  proxysql_mysql_users:
     config_file: '~/proxysql.cnf'
     username: 'mysqlboy'
     state: absent

plugins/modules/database/proxysql/proxysql_query_rules.py

@@ -153,7 +153,8 @@ EXAMPLES = '''
 # single batch using the M(proxysql_manage_config) module). It uses supplied
 # credentials to connect to the proxysql admin interface.
 
-- proxysql_query_rules:
+- name: Add a rule
+  proxysql_query_rules:
     login_user: admin
     login_password: admin
     username: 'guest_ro'
@@ -169,7 +170,8 @@ EXAMPLES = '''
 # config to runtime.  It uses credentials in a supplied config file to connect
 # to the proxysql admin interface.
 
-- proxysql_query_rules:
+- name: Remove rules
+  proxysql_query_rules:
     config_file: '~/proxysql.cnf'
     username: 'guest_ro'
     state: absent

plugins/modules/database/proxysql/proxysql_replication_hostgroups.py

@@ -51,7 +51,8 @@ EXAMPLES = '''
 # M(proxysql_manage_config) module).  It uses supplied credentials to connect
 # to the proxysql admin interface.
 
-- proxysql_replication_hostgroups:
+- name: Add a replication hostgroup
+  proxysql_replication_hostgroups:
     login_user: 'admin'
     login_password: 'admin'
     writer_hostgroup: 1
@@ -64,7 +65,8 @@ EXAMPLES = '''
 # credentials in a supplied config file to connect to the proxysql admin
 # interface.
 
-- proxysql_replication_hostgroups:
+- name: Remove a replication hostgroup
+  proxysql_replication_hostgroups:
     config_file: '~/proxysql.cnf'
     writer_hostgroup: 3
     reader_hostgroup: 4

plugins/modules/database/proxysql/proxysql_scheduler.py

@@ -75,7 +75,8 @@ EXAMPLES = '''
 # runtime in a single batch using the M(proxysql_manage_config) module).  It
 # uses supplied credentials to connect to the proxysql admin interface.
 
-- proxysql_scheduler:
+- name: Add a schedule
+  proxysql_scheduler:
     login_user: 'admin'
     login_password: 'admin'
     interval_ms: 1000
@@ -87,7 +88,8 @@ EXAMPLES = '''
 # dynamically loads the scheduler config to runtime.  It uses credentials
 # in a supplied config file to connect to the proxysql admin interface.
 
-- proxysql_scheduler:
+- name: Remove a schedule
+  proxysql_scheduler:
     config_file: '~/proxysql.cnf'
     filename: "/opt/old_script.py"
     state: absent