docs: 完善项目及数据源文档 (#4)

Signed-off-by: unique0lai <[email protected]>
TencentBlueKing · Nov 24, 2022 · ee737ef · ee737ef
1 parent 2fe4c14
commit ee737ef
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 6 deletions.
diff --git a/bkmonitor-event-datasource/README.md b/bkmonitor-event-datasource/README.md
@@ -1 +1,24 @@
-## 蓝鲸监控-事件数据 datasource 插件
+# Tencent Blueking Monitor Event DataSource
+
+> Note: This plugin requires Grafana version >= 7.5, for Grafana installation, please read [Download Grafana](https://grafana.com/grafana/download).
+
+# Introduction
+
+[Tencent Blueking Monitor](https://bk.tencent.com/docs/document/7.0/248/40001) is a part of Tencent Blueking Platform, is a product that monitors the host and Internet applications. The monitoring service can be used to collect monitoring metrics of host (system performance, component services, databases, logs, trace, etc.), detect the availability of Internet application services, and set alarms for metrics.
+
+This datasource will help you query event data from Tencent Blueking Monitor in your grafana.
+
+# Get Started
+
+Install the latest plugin using Grafana CLI:
+
+```bash
+$ grafana-cli plugins install bkmonitor-event-datasource
+```
+
+# Contact Us
+
+If you have any questions using this app, you are welcome to [create an issue](https://github.com/TencentBlueKing/bk-monitor-grafana-plugins/issues/new).
+
+# License
+Tencent Blueking Monitor Event DataSource is delivered under the [MIT](https://raw.githubusercontent.com/TencentBlueKing/bk-monitor-grafana-plugins/master/LICENSE).
diff --git a/bkmonitor-event-datasource/src/plugin.json b/bkmonitor-event-datasource/src/plugin.json
@@ -1,13 +1,24 @@
 {
   "type": "datasource",
-  "name": "蓝鲸监控-事件插件",
+  "name": "Blueing Monitor Event",
   "id": "bkmonitor-event-datasource",
-  "version": "0.0.1",
   "metrics": true,
   "annotations": false,
   "queryOptions": {
     "maxDataPoints": true
   },
+  "dependencies": {
+    "grafanaDependency": ">=7.5",
+    "grafanaVersion": "7.5",
+    "plugins": []
+  },
+  "links": [
+    { "name": "GitHub", "url": "https://github.com/TencentBlueKing/bkmonitor-grafana-plugins" },
+    {
+      "name": "License",
+      "url": "https://github.com/TencentBlueKing/bkmonitor-grafana-plugins/blob/master/LICENSE"
+    }
+  ],
   "routes": [
     {
       "path": "event",
@@ -25,6 +36,7 @@
     "author": {
       "name": "blueking"
     },
+    "version": "3.6.0",
     "logos": {
       "small": "img/logo.png",
       "large": "img/logo.png"

diff --git a/bkmonitor-timeseries-datasource/README.md b/bkmonitor-timeseries-datasource/README.md
@@ -1 +1,24 @@
-## 蓝鲸监控-时序数据 datasource 插件
+# Tencent Blueking Monitor TimeSeries DataSource
+
+> Note: This plugin requires Grafana version >= 7.5, for Grafana installation, please read [Download Grafana](https://grafana.com/grafana/download).
+
+# Introduction
+
+[Tencent Blueking Monitor](https://bk.tencent.com/docs/document/7.0/248/40001) is a part of Tencent Blueking Platform, is a product that monitors the host and Internet applications. The monitoring service can be used to collect monitoring metrics of host (system performance, component services, databases, logs, trace, etc.), detect the availability of Internet application services, and set alarms for metrics.
+
+This datasource will help you query timeseries metric data from Tencent Blueking Monitor in your grafana.
+
+# Get Started
+
+Install the latest plugin using Grafana CLI:
+
+```bash
+$ grafana-cli plugins install bkmonitor-timeseries-datasource
+```
+
+# Contact Us
+
+If you have any questions using this app, you are welcome to [create an issue](https://github.com/TencentBlueKing/bk-monitor-grafana-plugins/issues/new).
+
+# License
+Tencent Blueking Monitor TimeSeries DataSource is delivered under the [MIT](https://raw.githubusercontent.com/TencentBlueKing/bk-monitor-grafana-plugins/master/LICENSE).
diff --git a/bkmonitor-timeseries-datasource/src/plugin.json b/bkmonitor-timeseries-datasource/src/plugin.json
@@ -1,6 +1,6 @@
 {
   "type": "datasource",
-  "name": "蓝鲸监控-时序数据",
+  "name": "Blueing Monitor TimeSeries",
   "id": "bkmonitor-timeseries-datasource",
   "metrics": true,
   "annotations": false,
@@ -16,7 +16,7 @@
     { "name": "GitHub", "url": "https://github.com/TencentBlueKing/bkmonitor-grafana-plugins" },
     {
       "name": "License",
-      "url": "https://github.com/TencentBlueKing/bkmonitor-grafana-plugins/blob/master/LICENSE.txt"
+      "url": "https://github.com/TencentBlueKing/bkmonitor-grafana-plugins/blob/master/LICENSE"
     }
   ],
   "routes": [