From aaa98e13b6e9e60d2b8e0b90dff6137d909fb327 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 10 Mar 2015 16:17:50 +0100 Subject: [PATCH] updated docs --- docs/mkdocs.yml | 20 +++++++++---------- .../guides/{intro.md => gettingstarted.md} | 0 docs/sources/index.md | 8 ++++---- .../building_from_source.md | 0 docs/sources/{contributing => project}/cla.md | 0 .../sources/reference/{graphs.md => graph.md} | 0 .../{scripted_dashboards.md => scripting.md} | 0 ...{templated_dashboards.md => templating.md} | 0 .../reference/{time_range.md => timerange.md} | 0 9 files changed, 14 insertions(+), 14 deletions(-) rename docs/sources/guides/{intro.md => gettingstarted.md} (100%) rename docs/sources/{contributing => project}/building_from_source.md (100%) rename docs/sources/{contributing => project}/cla.md (100%) rename docs/sources/reference/{graphs.md => graph.md} (100%) rename docs/sources/reference/{scripted_dashboards.md => scripting.md} (100%) rename docs/sources/reference/{templated_dashboards.md => templating.md} (100%) rename docs/sources/reference/{time_range.md => timerange.md} (100%) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 82b1714741d..7b90461ba92 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -31,23 +31,23 @@ pages: - ['installation/performance.md', 'Installation', 'Performance tips'] - ['installation/troubleshooting.md', 'Installation', 'Troubleshooting'] -- ['guides/intro.md', 'User Guides', 'Getting started'] +- ['guides/gettingstarted.md', 'User Guides', 'Getting started'] - ['guides/screencasts.md', 'User Guides', 'Screencasts'] -- ['reference/graphs.md', 'Reference', 'Graph options'] +- ['reference/graph.md', 'Reference', 'Graph options'] - ['reference/annotations.md', 'Reference', 'Annotations'] -- ['reference/time_range.md', 'Reference', 'Time range controls'] +- ['reference/timerange.md', 'Reference', 'Time range controls'] - ['reference/search.md', 'Reference', 'Dashboard Search'] -- ['reference/templated_dashboards.md', 'Reference', 'Templated dashboards'] -- ['reference/scripted_dashboards.md', 'Reference', 'Scripted dashboards'] +- ['reference/templating.md', 'Reference', 'Templated dashboards'] +- ['reference/scripting.md', 'Reference', 'Scripted dashboards'] - ['reference/playlist.md', 'Reference', 'Playlist'] - ['reference/export_import.md', 'Reference', 'Import & Export'] -- ['datasources/graphite.md', 'Data Sources', 'Graphite guide'] -- ['datasources/influxdb.md', 'Data Sources', 'InfluxDB guide'] -- ['datasources/opentsdb.md', 'Data Sources', 'OpenTSDB guide'] +- ['datasources/graphite.md', 'Data Sources', 'Graphite'] +- ['datasources/influxdb.md', 'Data Sources', 'InfluxDB'] +- ['datasources/opentsdb.md', 'Data Sources', 'OpenTSDB'] -- ['contributing/building_from_source.md', 'Project', 'Building from souce'] -- ['contributing/cla.md', 'Project', 'Contributor License Agreement'] +- ['project/building_from_source.md', 'Project', 'Building from souce'] +- ['project/cla.md', 'Project', 'Contributor License Agreement'] - ['jsearch.md', '**HIDDEN**'] diff --git a/docs/sources/guides/intro.md b/docs/sources/guides/gettingstarted.md similarity index 100% rename from docs/sources/guides/intro.md rename to docs/sources/guides/gettingstarted.md diff --git a/docs/sources/index.md b/docs/sources/index.md index 66094e590dc..26bdbb33993 100644 --- a/docs/sources/index.md +++ b/docs/sources/index.md @@ -4,10 +4,10 @@ page_keywords: grafana, introduction, documentation, about # About Grafana -Grafana is a general purpose dashboard and graph composer. Its focused on providing -rich ways to visualize time series metrics, mainly though graphs. It currently -has rich support for for [Graphite](http://graphite.readthedocs.org/en/latest/), [InfluxDB](http://influxdb.org) -and [OpenTSDB](http://opentsdb.net). But supports other data sources via plugins. +Grafana is a general purpose dashboard and graph composer. It's focused on providing +rich ways to visualize time series metrics, mainly though graphs but supports other ways to visualize data through +a pluggable panel architecture. It currently has rich support for for [Graphite](http://graphite.readthedocs.org/en/latest/), +[InfluxDB](http://influxdb.org) and [OpenTSDB](http://opentsdb.net). But supports other data sources via plugins. It is most common usage is for infrastructure monitoring, application monitoring and metric analytics. But Grafana has an open architecture and design that enabled is to be used in other domains as well, like home automation, diff --git a/docs/sources/contributing/building_from_source.md b/docs/sources/project/building_from_source.md similarity index 100% rename from docs/sources/contributing/building_from_source.md rename to docs/sources/project/building_from_source.md diff --git a/docs/sources/contributing/cla.md b/docs/sources/project/cla.md similarity index 100% rename from docs/sources/contributing/cla.md rename to docs/sources/project/cla.md diff --git a/docs/sources/reference/graphs.md b/docs/sources/reference/graph.md similarity index 100% rename from docs/sources/reference/graphs.md rename to docs/sources/reference/graph.md diff --git a/docs/sources/reference/scripted_dashboards.md b/docs/sources/reference/scripting.md similarity index 100% rename from docs/sources/reference/scripted_dashboards.md rename to docs/sources/reference/scripting.md diff --git a/docs/sources/reference/templated_dashboards.md b/docs/sources/reference/templating.md similarity index 100% rename from docs/sources/reference/templated_dashboards.md rename to docs/sources/reference/templating.md diff --git a/docs/sources/reference/time_range.md b/docs/sources/reference/timerange.md similarity index 100% rename from docs/sources/reference/time_range.md rename to docs/sources/reference/timerange.md