浏览代码

docs(plugins): improve install docs for plugins

bergquist 9 年之前
父节点
当前提交
8b64b2113e
共有 2 个文件被更改,包括 13 次插入8 次删除
  1. 4 1
      docs/mkdocs.yml
  2. 9 7
      docs/sources/plugins/installation.md

+ 4 - 1
docs/mkdocs.yml

@@ -86,7 +86,10 @@ pages:
 - ['http_api/snapshot.md', 'API', 'Snapshot API']
 - ['http_api/other.md', 'API', 'Other API']
 
-- ['plugins/plugins.md', 'Plugins', 'Plugins']
+- ['plugins/overview.md', 'Plugins', 'Overview']
+- ['plugins/installation.md', 'Plugins', 'Installation']
+- ['plugins/datasources.md', 'Plugins', 'Datasource plugins']
+- ['plugins/panels.md', 'Plugins', 'Panel plugins']
 
 - ['tutorials/index.md', 'Tutorials', 'Tutorials']
 - ['tutorials/hubot_howto.md', 'Tutorials', 'How To integrate Hubot and Grafana']

+ 9 - 7
docs/sources/plugins/installation.md

@@ -8,37 +8,39 @@ page_keywords: grafana, plugins, documentation
 
 ## Installing plugins
 
-The easiest way to install plugins is by using the CLI tool grafana-cli which is bundled with grafana.
+The easiest way to install plugins is by using the CLI tool grafana-cli which is bundled with grafana. Before any modification take place after modifieng plugins, grafana-server need to be restarted.
 
 ### Grafana plugin directory
 On Linux systems the grafana-cli will assume that the grafana plugin directory is "/var/lib/grafana/plugins". Its possible to override the directory which grafana-cli will operate on by specifing the --path flag. On Windows systems this parameter have to be specified for every call.
 
-### List available plugins
+### Grafana-cli commands
+
+List available plugins
 ```
 grafana-cli list-remove
 ```
 
-### Install a plugin type
+Install a plugin type
 ```
 grafana-cli install <plugin-id>
 ```
 
-### List installed plugins
+List installed plugins
 ```
 grafana-cli ls
 ```
 
-### Upgrade all installed plugins
+Upgrade all installed plugins
 ```
 grafana-cli upgrade-all
 ```
 
-### Upgrade one plugin
+Upgrade one plugin
 ```
 grafana-cli upgrade <plugin-id>
 ```
 
-### Remove one plugin
+Remove one plugin
 ```
 grafana-cli remove <plugin-id>
 ```