From 8b64b2113eb38a674b8d42919b104d51e31ca2c2 Mon Sep 17 00:00:00 2001 From: bergquist Date: Wed, 2 Mar 2016 08:38:56 +0100 Subject: [PATCH] docs(plugins): improve install docs for plugins --- docs/mkdocs.yml | 5 ++++- docs/sources/plugins/installation.md | 16 +++++++++------- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5e99db71bdf..e88b5ec4237 100644 --- a/docs/mkdocs.yml +++ b/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'] diff --git a/docs/sources/plugins/installation.md b/docs/sources/plugins/installation.md index c8bc9e813eb..b6db0e82b2c 100644 --- a/docs/sources/plugins/installation.md +++ b/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 ``` -### 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 ``` -### Remove one plugin +Remove one plugin ``` grafana-cli remove ```