Ver código fonte

Merge branch 'docs-1.x' into develop

Torkel Ödegaard 10 anos atrás
pai
commit
4244ed33c8

+ 19 - 20
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']
-
-- ['features/graphite.md', 'Metric Queries', 'Graphite guide']
-- ['features/influxdb.md', 'Metric Queries', 'InfluxDB guide']
-- ['features/opentsdb.md', 'Metric Queries', 'OpenTSDB guide']
-
-- ['contributing/building_from_source.md', 'Contribute', 'Building from souce']
-- ['contributing/cla.md', 'Contribute', 'Contributor License Agreement']
-
-- ['support/index.md', 'Support', 'Support']
+- ['guides/gettingstarted.md', 'User Guides', 'Getting started']
+- ['guides/screencasts.md', 'User Guides', 'Screencasts']
+
+- ['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']
+
+- ['datasources/graphite.md', 'Data Sources', 'Graphite']
+- ['datasources/influxdb.md', 'Data Sources', 'InfluxDB']
+- ['datasources/opentsdb.md', 'Data Sources', 'OpenTSDB']
+
+- ['project/building_from_source.md', 'Project', 'Building from souce']
+- ['project/cla.md', 'Project', 'Contributor License Agreement']
 
 - ['jsearch.md', '**HIDDEN**']

+ 0 - 0
docs/sources/features/graphite.md → docs/sources/datasources/graphite.md


+ 0 - 0
docs/sources/features/influxdb.md → docs/sources/datasources/influxdb.md


+ 0 - 0
docs/sources/features/opentsdb.md → docs/sources/datasources/opentsdb.md


+ 0 - 0
docs/sources/features/intro.md → docs/sources/guides/gettingstarted.md


+ 0 - 0
docs/sources/screencasts/index.md → docs/sources/guides/screencasts.md


+ 26 - 5
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
 

+ 1 - 7
docs/sources/installation/installation.md → 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.
 

+ 0 - 0
docs/sources/contributing/building_from_source.md → docs/sources/project/building_from_source.md


+ 0 - 0
docs/sources/contributing/cla.md → docs/sources/project/cla.md


+ 0 - 0
docs/sources/features/annotations.md → docs/sources/reference/annotations.md


+ 0 - 0
docs/sources/features/export_import.md → docs/sources/reference/export_import.md


+ 0 - 0
docs/sources/features/graphs.md → docs/sources/reference/graph.md


+ 0 - 0
docs/sources/features/playlist.md → docs/sources/reference/playlist.md


+ 0 - 0
docs/sources/features/scripted_dashboards.md → docs/sources/reference/scripting.md


+ 0 - 0
docs/sources/features/search.md → docs/sources/reference/search.md


+ 0 - 0
docs/sources/features/templated_dashboards.md → docs/sources/reference/templating.md


+ 0 - 0
docs/sources/features/time_range.md → docs/sources/reference/timerange.md


+ 0 - 12
docs/sources/screencasts/feature_tour/index.html.slim

@@ -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"
-

+ 0 - 11
docs/sources/screencasts/function_editor/index.html.slim

@@ -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"
-

+ 0 - 20
docs/sources/support/index.md

@@ -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).