Docs fixes (#66)

Co-authored-by: Ishan Jain <[email protected]>
grafana · Jun 27, 2023 · bd1871b · bd1871b
1 parent 3c273ca
commit bd1871b
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 6 deletions.
diff --git a/plugins/modules/alert_contact_point.py b/plugins/modules/alert_contact_point.py
@@ -12,7 +12,7 @@
 author:
   - Ishan Jain (@ishanjainn)
 version_added: "0.0.1"
-short_description: Manage Alerting Contact points in Grafana Cloud
+short_description: Manage Alerting Contact points in Grafana
 description:
   - Create, Update and delete Contact points using Ansible.
 requirements: [ "requests >= 1.0.0" ]

diff --git a/plugins/modules/alert_notification_policy.py b/plugins/modules/alert_notification_policy.py
@@ -12,7 +12,7 @@
 author:
   - Ishan Jain (@ishanjainn)
 version_added: "0.0.1"
-short_description: Sets the notification policy tree in Alerting on Grafana Cloud
+short_description: Manage Alerting Policies points in Grafana
 description:
   - Set the notification policy tree using Ansible.
 requirements: [ "requests >= 1.0.0" ]

diff --git a/plugins/modules/dashboard.py b/plugins/modules/dashboard.py
@@ -12,7 +12,7 @@
 author:
   - Ishan Jain (@ishanjainn)
 version_added: "0.0.1"
-short_description: Manage Dashboards in Grafana Cloud
+short_description: Manage Dashboards in Grafana
 description:
   - Create, Update and delete Dashboards using Ansible.
 requirements: [ "requests >= 1.0.0" ]

diff --git a/plugins/modules/datasource.py b/plugins/modules/datasource.py
@@ -12,7 +12,7 @@
 author:
   - Ishan Jain (@ishanjainn)
 version_added: "0.0.1"
-short_description: Manage Data sources in Grafana Cloud
+short_description: Manage Data sources in Grafana
 description:
   - Create, Update and delete Data sources using Ansible.
 requirements: [ "requests >= 1.0.0" ]
@@ -46,7 +46,19 @@
 EXAMPLES = '''
 - name: Create/Update Data sources
   grafana.grafana.datasource:
-    dataSource: "{{ lookup('ansible.builtin.file', 'datasource.json') }}"
+    dataSource: |
+      {
+        "name": "Prometheus",
+        "type": "prometheus",
+        "access": "proxy",
+        "url": "http://localhost:9090",
+        "jsonData": {
+          "httpMethod": "POST",
+          "manageAlerts": true,
+          "prometheusType": "Prometheus",
+          "cacheLevel": "High"
+        }
+      }
     grafana_url: "{{ grafana_url }}"
     grafana_api_key: "{{ grafana_api_key }}"
     state: present

diff --git a/plugins/modules/folder.py b/plugins/modules/folder.py
@@ -12,7 +12,7 @@
 author:
   - Ishan Jain (@ishanjainn)
 version_added: "0.0.1"
-short_description: Manage Folders in Grafana Cloud
+short_description: Manage Folders in Grafana
 description:
   - Create, Update and delete Folders via Ansible.
 requirements: [ "requests >= 1.0.0" ]