diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 67944930fa5..7b90461ba92 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -26,29 +26,28 @@ pages: # Introduction: - ['index.md', 'About', 'Grafana'] -- ['installation/installation.md', 'Installation', 'Install & Configure'] +- ['installation/index.md', 'Installation', 'Install & Configure'] - ['installation/provisioning.md', 'Installation', 'Provisioning'] - ['installation/performance.md', 'Installation', 'Performance tips'] - ['installation/troubleshooting.md', 'Installation', 'Troubleshooting'] -- ['features/intro.md', 'User Guides', 'Getting started'] -- ['features/graphs.md', 'User Guides', 'Graph options'] -- ['features/annotations.md', 'User Guides', 'Annotations'] -- ['features/time_range.md', 'User Guides', 'Time range controls'] -- ['features/search.md', 'User Guides', 'Search features'] -- ['features/templated_dashboards.md', 'User Guides', 'Templated dashboards'] -- ['features/scripted_dashboards.md', 'User Guides', 'Scripted dashboards'] -- ['features/playlist.md', 'User Guides', 'Playlist'] -- ['features/export_import.md', 'User Guides', 'Import & Export'] -- ['screencasts/index.md', 'User Guides', 'Screencasts'] +- ['guides/gettingstarted.md', 'User Guides', 'Getting started'] +- ['guides/screencasts.md', 'User Guides', 'Screencasts'] -- ['features/graphite.md', 'Metric Queries', 'Graphite guide'] -- ['features/influxdb.md', 'Metric Queries', 'InfluxDB guide'] -- ['features/opentsdb.md', 'Metric Queries', 'OpenTSDB guide'] +- ['reference/graph.md', 'Reference', 'Graph options'] +- ['reference/annotations.md', 'Reference', 'Annotations'] +- ['reference/timerange.md', 'Reference', 'Time range controls'] +- ['reference/search.md', 'Reference', 'Dashboard Search'] +- ['reference/templating.md', 'Reference', 'Templated dashboards'] +- ['reference/scripting.md', 'Reference', 'Scripted dashboards'] +- ['reference/playlist.md', 'Reference', 'Playlist'] +- ['reference/export_import.md', 'Reference', 'Import & Export'] -- ['contributing/building_from_source.md', 'Contribute', 'Building from souce'] -- ['contributing/cla.md', 'Contribute', 'Contributor License Agreement'] +- ['datasources/graphite.md', 'Data Sources', 'Graphite'] +- ['datasources/influxdb.md', 'Data Sources', 'InfluxDB'] +- ['datasources/opentsdb.md', 'Data Sources', 'OpenTSDB'] -- ['support/index.md', 'Support', 'Support'] +- ['project/building_from_source.md', 'Project', 'Building from souce'] +- ['project/cla.md', 'Project', 'Contributor License Agreement'] - ['jsearch.md', '**HIDDEN**'] diff --git a/docs/sources/features/graphite.md b/docs/sources/datasources/graphite.md similarity index 100% rename from docs/sources/features/graphite.md rename to docs/sources/datasources/graphite.md diff --git a/docs/sources/features/influxdb.md b/docs/sources/datasources/influxdb.md similarity index 100% rename from docs/sources/features/influxdb.md rename to docs/sources/datasources/influxdb.md diff --git a/docs/sources/features/opentsdb.md b/docs/sources/datasources/opentsdb.md similarity index 100% rename from docs/sources/features/opentsdb.md rename to docs/sources/datasources/opentsdb.md diff --git a/docs/sources/features/intro.md b/docs/sources/guides/gettingstarted.md similarity index 100% rename from docs/sources/features/intro.md rename to docs/sources/guides/gettingstarted.md diff --git a/docs/sources/screencasts/index.md b/docs/sources/guides/screencasts.md similarity index 100% rename from docs/sources/screencasts/index.md rename to docs/sources/guides/screencasts.md diff --git a/docs/sources/index.md b/docs/sources/index.md index e0411164e3e..26bdbb33993 100644 --- a/docs/sources/index.md +++ b/docs/sources/index.md @@ -2,12 +2,33 @@ page_title: About Grafana page_description: Introduction to Grafana. page_keywords: grafana, introduction, documentation, about -# 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, +weather and industrial sensors analytics. + +## Support + +If you have any trouble with Grafana, either the install or some feature you do not understand or you suspect isn't working +correctly there are a number of sources where you can get help. + +- [Troubleshooting guide](../troubleshooting) +- \#grafana IRC channel on freenode +- Search closed and open [issues on github](https://github.com/grafana/grafana/issues). +- [Mailing list](https://groups.io/org/groupsio/grafana) + +Do not hesitate to open a new issue with a question, bug report or an idea for improvement. + +User feedback and involvement is paramount to making a product better so please take the time and create an issue. + +## Paid support +If you wish to get paid support please [contact us](mailto:contact@grafana.org). ## License diff --git a/docs/sources/installation/installation.md b/docs/sources/installation/index.md similarity index 93% rename from docs/sources/installation/installation.md rename to docs/sources/installation/index.md index 8d2448665a3..3b49cfa2761 100644 --- a/docs/sources/installation/installation.md +++ b/docs/sources/installation/index.md @@ -6,13 +6,7 @@ page_keywords: grafana, installation, documentation # Installation -Grafana is a frontend for [Graphite](http://graphite.readthedocs.org/en/latest/), [InfluxDB](http://influxdb.org) -and [OpenTSDB](http://opentsdb.net) with powerfull visualization features for time series data. -You will need either a Graphite, InfluxDB or OpenTSDB server for Grafana to be of any use. - -## Download - -[Download](/download) the latest release. The release package contain a subfolder, for example **grafana-1.7.0**. The +[Download](http://grafana.org/download) the latest release. The release package contain a subfolder, for example **grafana-1.7.0**. The contents of this folder should be hosted by a web server, for example nginx, apache, IIS. The standard release packages does not contain a web server to host Grafana. 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/features/annotations.md b/docs/sources/reference/annotations.md similarity index 100% rename from docs/sources/features/annotations.md rename to docs/sources/reference/annotations.md diff --git a/docs/sources/features/export_import.md b/docs/sources/reference/export_import.md similarity index 100% rename from docs/sources/features/export_import.md rename to docs/sources/reference/export_import.md diff --git a/docs/sources/features/graphs.md b/docs/sources/reference/graph.md similarity index 100% rename from docs/sources/features/graphs.md rename to docs/sources/reference/graph.md diff --git a/docs/sources/features/playlist.md b/docs/sources/reference/playlist.md similarity index 100% rename from docs/sources/features/playlist.md rename to docs/sources/reference/playlist.md diff --git a/docs/sources/features/scripted_dashboards.md b/docs/sources/reference/scripting.md similarity index 100% rename from docs/sources/features/scripted_dashboards.md rename to docs/sources/reference/scripting.md diff --git a/docs/sources/features/search.md b/docs/sources/reference/search.md similarity index 100% rename from docs/sources/features/search.md rename to docs/sources/reference/search.md diff --git a/docs/sources/features/templated_dashboards.md b/docs/sources/reference/templating.md similarity index 100% rename from docs/sources/features/templated_dashboards.md rename to docs/sources/reference/templating.md diff --git a/docs/sources/features/time_range.md b/docs/sources/reference/timerange.md similarity index 100% rename from docs/sources/features/time_range.md rename to docs/sources/reference/timerange.md diff --git a/docs/sources/screencasts/feature_tour/index.html.slim b/docs/sources/screencasts/feature_tour/index.html.slim deleted file mode 100644 index 777c49c729f..00000000000 --- a/docs/sources/screencasts/feature_tour/index.html.slim +++ /dev/null @@ -1,12 +0,0 @@ - - -h1 Grafana video tour - -.row - .panel.callout - | This video will show you some of the basic features like building graphs and dashboards. It is a little outdated, the function - | editor has been much improved since this video was made. - -.row - iframe width="513" height="317" src="//www.youtube.com/embed/OUvJamHeMpw?vq=hd1080" frameborder="0" allowfullscreen="1" - diff --git a/docs/sources/screencasts/function_editor/index.html.slim b/docs/sources/screencasts/function_editor/index.html.slim deleted file mode 100644 index e51878e53ff..00000000000 --- a/docs/sources/screencasts/function_editor/index.html.slim +++ /dev/null @@ -1,11 +0,0 @@ - - -h1 Grafana 1.5 Function editor - -.row - .panel.callout - | This video demos the new Graphite function editor that was introduced in Grafana v1.5 - -.row - iframe width="513" height="317" src="//www.youtube.com/embed/I90WHRwE1ZM?vq=hd1080" frameborder="0" allowfullscreen="1" - diff --git a/docs/sources/support/index.md b/docs/sources/support/index.md deleted file mode 100644 index cf68fb5f19a..00000000000 --- a/docs/sources/support/index.md +++ /dev/null @@ -1,20 +0,0 @@ -page_title: Support -page_description: Support options for Grafana. -page_keywords: grafana, support, documentation - -# Support - -If you have any trouble with Grafana, either the install or some feature you do not understand or you suspect isn't working -correctly there are a number of sources where you can get help. - -- [Troubleshooting guide](../troubleshooting) -- \#grafana IRC channel on freenode -- Search closed and open [issues on github](https://github.com/grafana/grafana/issues). -- [Mailing list](https://groups.io/org/groupsio/grafana) - -Do not hesitate to open a new issue with a question, bug report or an idea for improvement. - -User feedback and involvement is paramount to making a product better so please take the time and create an issue. - -## Paid support -If you wish to get paid support please [contact us](mailto:contact@grafana.org).