Clean up Grafana docs a bit (#37516)

* Clean up Grafana docs a bit

But more is needed, default values, missing choices, proper
descriptions, actual sentences :-)

* Remove validate-modules entries
This commit is contained in:
Dag Wieers 2018-03-17 02:53:26 +01:00 committed by GitHub
commit 51662acc6c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 112 additions and 137 deletions

View file

@ -1,7 +1,7 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright 2017, Thierry Sallé (@tsalle)
# Copyright: (c) 2017, Thierry Sallé (@tsalle)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
@ -16,20 +16,20 @@ DOCUMENTATION = '''
---
module: grafana_plugin
author:
- "Thierry Sallé (@tsalle)"
- Thierry Sallé (@tsalle)
version_added: "2.5"
short_description: Manage Grafana plugins via grafana-cli
description:
- Install and remove Grafana plugins.
options:
name:
required: true
description:
- Name of the plugin.
required: true
version:
description:
- Version of the plugin to install.
- Default to latest
- Default to latest.
grafana_plugins_dir:
description:
- Directory where Grafana plugin will be installed.
@ -38,19 +38,19 @@ options:
- Grafana repository. If not set, gafana-cli will use the default value C(https://grafana.net/api/plugins).
grafana_plugin_url:
description:
- Custom Grafana plugin URL
- Require grafana 4.6.x or later
- Custom Grafana plugin URL.
- Requires grafana 4.6.x or later.
state:
default: present
choices: [present, absent]
description:
- Status of the Grafana plugin.
- If latest is set, the version parameter will be ignored.
choices: [ absent, present ]
default: present
'''
EXAMPLES = '''
---
- name: install - update Grafana piechart panel plugin
- name: Install - update Grafana piechart panel plugin
grafana_plugin:
name: grafana-piechart-panel
version: latest