public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: update content to work with website repo (#20693)

Browse Source 
Updates the docs to work with the website repo - mainly 
relative link updates.
Adds a menu.yaml file to build the sidebar menu (no longer 
using front matter weight).
This commit is contained in:
Robby Milo
2019-12-05 13:09:57 +01:00
committed by Marcus Efraimsson
parent 827688f152
commit cbd81ffeb8
73 changed files with 507 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/guides/basic_concepts.md
Regular → Executable
+6 -6
View File
@@ -20,12 +20,12 @@ Grafana supports many different storage backends for your time series data (Data
The following data sources are officially supported:
* [CloudWatch]({{< relref "features/datasources/cloudwatch.md" >}})
* [Elasticsearch]({{< relref "features/datasources/elasticsearch.md" >}})
* [Graphite]({{< relref "features/datasources/graphite.md" >}})
* [InfluxDB]({{< relref "features/datasources/influxdb.md" >}})
* [OpenTSDB]({{< relref "features/datasources/opentsdb.md" >}})
* [Prometheus]({{< relref "features/datasources/prometheus.md" >}})
* [CloudWatch]({{< relref "../features/datasources/cloudwatch.md" >}})
* [Elasticsearch]({{< relref "../features/datasources/elasticsearch.md" >}})
* [Graphite]({{< relref "../features/datasources/graphite.md" >}})
* [InfluxDB]({{< relref "../features/datasources/influxdb.md" >}})
* [OpenTSDB]({{< relref "../features/datasources/opentsdb.md" >}})
* [Prometheus]({{< relref "../features/datasources/prometheus.md" >}})
The query language and capabilities of each Data Source are obviously very different. You can combine data from multiple Data Sources onto a single Dashboard, but each Panel is tied to a specific Data Source that belongs to a particular Organization.
docs/sources/guides/getting_started.md
Regular → Executable
+5 -5
View File
@@ -13,11 +13,11 @@ weight = 1
# Getting started
This guide will help you get started and acquainted with Grafana. It assumes you have a working Grafana server up and running. If not please read the [installation guide](/installation/).
This guide will help you get started and acquainted with Grafana. It assumes you have a working Grafana server up and running. If not please read the [installation guide]({{< relref "../installation/" >}}).
## Logging in for the first time
To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default HTTP port that Grafana listens to if you haven't [configured a different port](/installation/configuration/#http-port).
To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default HTTP port that Grafana listens to if you haven't [configured a different port]({{< relref "../installation/configuration/#http-port" >}}).
There you will see the login page. Default username is admin and default password is admin. When you log in for the first time you will be asked to change your password. We strongly encourage you to
follow Grafana’s best practices and change the default administrator password. You can later go to user preferences and change your user name.
@@ -36,7 +36,7 @@ Click Add data source and you will come to the settings page of your new data so
{{< docs-imagebox img="/img/docs/v52/add-datasource.png" max-width="700px" class="docs-image--no-shadow">}}
First, give the data source a Name and then select which Type of data source you'll want to create, see [Supported data sources](/features/datasources/#supported-data-sources/) for more information and how to configure your data source.
First, give the data source a Name and then select which Type of data source you'll want to create, see [Supported data sources]({{< relref "../features/datasources/#supported-data-sources/" >}}) for more information and how to configure your data source.
{{< docs-imagebox img="/img/docs/v52/datasource-settings.png" max-width="700px" class="docs-image--no-shadow">}}
@@ -49,7 +49,7 @@ Watch the 10min [beginners guide to building dashboards](https://www.youtube.com
## Basic concepts
Read the [Basic Concepts](/guides/basic_concepts) document to get a crash course in key Grafana concepts.
Read the [Basic Concepts]({{< relref "basic_concepts" >}}) document to get a crash course in key Grafana concepts.
### Top header
@@ -69,7 +69,7 @@ The image above shows you the top header for a Dashboard.
## Dashboards, panels, the building blocks of Grafana...
Dashboards are at the core of what Grafana is all about. Dashboards are composed of individual Panels arranged on a grid. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect Dashboard for your need. Each Panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). The [Basic Concepts](/guides/basic_concepts) guide explores these key ideas in detail.
Dashboards are at the core of what Grafana is all about. Dashboards are composed of individual Panels arranged on a grid. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect Dashboard for your need. Each Panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). The [Basic Concepts]({{< relref "basic_concepts" >}}) guide explores these key ideas in detail.
<img src="/img/docs/v50/dashboard_annotated.png" class="no-shadow" width="700px">
docs/sources/guides/timeseries.md
Regular → Executable
View File
docs/sources/guides/whats-new-in-v4-6.md
+1 -1
View File
@@ -19,7 +19,7 @@ Grafana v4.6 brings many enhancements to Annotations, Cloudwatch and Prometheus.
{{< docs-imagebox img="/img/docs/v46/add_annotation_region.png" max-width= "800px" >}}
You can now add annotation events and regions right from the graph panel! Just hold Ctrl/Cmd+Click or drag region to open the **Add Annotation** view. The
[Annotations]({{< relref "reference/annotations.md" >}}) documentation is updated to include details on this new exciting feature.
[Annotations]({{< relref "../reference/annotations.md" >}}) documentation is updated to include details on this new exciting feature.
### Cloudwatch
docs/sources/guides/whats-new-in-v6-3.md
+2 -2
View File
@@ -130,13 +130,13 @@ belonging to an LDAP group that gives them access to Grafana.
Built-in support for SAML is now available in Grafana Enterprise.
[See docs]({{< relref "auth/saml.md" >}})
[See docs]({{< relref "../auth/saml.md" >}})
### Team Sync for GitHub OAuth
When setting up OAuth with GitHub it's now possible to sync GitHub teams with Teams in Grafana.
[See docs]({{< relref "auth/github.md" >}})
[See docs]({{< relref "../auth/github.md" >}})
### Team Sync for Auth Proxy
docs/sources/guides/whats-new-in-v6-4.md
+1 -1
View File
@@ -121,7 +121,7 @@ You'll be able to see how a user authenticating with LDAP would be mapped and wh
The feature is currently limited to Grafana Server Admins.
For more information on how to use this new feature, follow the [guide]({{< relref "auth/ldap.md#ldap-debug-view" >}}).
For more information on how to use this new feature, follow the [guide]({{< relref "../auth/ldap.md#ldap-debug-view" >}}).
## Grafana Enterprise
docs/sources/guides/whats-new-in-v6-5.md
Regular → Executable
+11 -11
View File
@@ -34,7 +34,7 @@ Grafana 6.5 comes with a lot of new features and enhancements:
### Ubuntu-based Docker images
In Grafana [v6.4](/guides/whats-new-in-v6-4/#alpine-based-docker-image), we switched the Grafana Docker image from Ubuntu to Alpine. This change provides a more secure and lightweight Docker image.
In Grafana [v6.4]({{< relref "whats-new-in-v6-4/#alpine-based-docker-image" >}}), we switched the Grafana Docker image from Ubuntu to Alpine. This change provides a more secure and lightweight Docker image.
This change has received both negative and positive feedback as well as some bug reports. We learned that switching to an Alpine-based Docker image was a big breaking change for a lot of users. We should have more clearly highlighted this in blog post, release notes, changelog, and the [Docker Hub readme](https://hub.docker.com/r/grafana/grafana).
@@ -42,7 +42,7 @@ We also broke the Docker images for ARM, but this is fixed in Grafana v6.5.
Grafana Docker images should be as secure as possible by default and that’s why the Alpine-based Docker images will continue to be the Grafana default (`grafana/grafana:<version>`). With that said, it’s good to give users options, and that’s why starting from Grafana v6.5, Ubuntu-based Docker images are also (`grafana/grafana:<version>-ubuntu`) available.
Read more about [Installing using Docker](/installation/docker/).
Read more about [Installing using Docker]({{< relref "../installation/docker/" >}}).
### CloudWatch data source improvements
@@ -120,7 +120,7 @@ TagValues
tag_values(server, server=~${__searchFilter:regex})
```
This feature is currently only supported by [Graphite](/features/datasources/graphite/#using-searchfilter-to-filter-results-in-query-variable), [MySQL](/features/datasources/mysql/#using-searchfilter-to-filter-results-in-query-variable) and [Postgres](/features/datasources/postgres/#using-searchfilter-to-filter-results-in-query-variable) data sources.
This feature is currently only supported by [Graphite]({{< relref "../features/datasources/graphite/#using-searchfilter-to-filter-results-in-query-variable" >}}), [MySQL]({{< relref "../features/datasources/mysql/#using-searchfilter-to-filter-results-in-query-variable" >}}) and [Postgres]({{< relref "../features/datasources/postgres/#using-searchfilter-to-filter-results-in-query-variable" >}}) data sources.
### Graphite: Support for additional Metrictank functionality
@@ -174,37 +174,37 @@ In the Explore split view, you can now link the two timepickers so that if you c
### Alerting support for Azure Application Insights
The [Azure Monitor](/features/datasources/azuremonitor/) data source supports multiple services in the Azure cloud. Before Grafana v6.5, only the Azure Monitor service had support for [Grafana Alerting](/alerting/rules). In Grafana 6.5, alerting support has been implemented for the [Application Insights service](/features/datasources/azuremonitor/#querying-the-application-insights-service).
The [Azure Monitor]({{< relref "../features/datasources/azuremonitor/" >}}) data source supports multiple services in the Azure cloud. Before Grafana v6.5, only the Azure Monitor service had support for [Grafana Alerting]({{< relref "../alerting/rules" >}}). In Grafana 6.5, alerting support has been implemented for the [Application Insights service]({{< relref "../features/datasources/azuremonitor/#querying-the-application-insights-service" >}}).
### Allow saving of provisioned dashboards from UI
Historically it has been possible to make changes to a provisioned dashboard in the Grafana UI. However, it hasn't been possible to save the changes without manual intervention. In Grafana 6.5 we introduce a new dashboard provisioning setting named `allowUiUpdates`. If `allowUiUpdates` is set to `true` and you make changes to a provisioned dashboard, you can save the dashboard and the changes will be persisted to the Grafana database.
Read more about this new feature in [Provisioning Grafana](/administration/provisioning/#making-changes-to-a-provisioned-dashboard).
Read more about this new feature in [Provisioning Grafana]({{< relref "../administration/provisioning/#making-changes-to-a-provisioned-dashboard" >}}).
### Mix auth proxy with Grafana login token and session cookie
With the new setting, `enable_login_token`, set to true Grafana will, after successful auth proxy header validation, assign the user a login token and cookie. You only have to configure your auth proxy to provide headers for the /login route. Requests via other routes will be authenticated using the cookie.
Read more about this new feature in [Auth Proxy Authentication](/auth/auth-proxy/#login-token-and-session-cookie)
Read more about this new feature in [Auth Proxy Authentication]({{< relref "../auth/auth-proxy/#login-token-and-session-cookie" >}})
### Generic OAuth role mapping
Grafana 6.5 makes it possible to configure Generic OAuth to map a certain response from OAuth provider to a certain Grafana organization role, similar to the existing [LDAP Group Mappings](/auth/ldap/#group-mappings) feature. The new setting is named `role_attribute_path` and expects a [JMESPath](http://jmespath.org/) expression.
Grafana 6.5 makes it possible to configure Generic OAuth to map a certain response from OAuth provider to a certain Grafana organization role, similar to the existing [LDAP Group Mappings]({{< relref "../auth/ldap/#group-mappings" >}}) feature. The new setting is named `role_attribute_path` and expects a [JMESPath](http://jmespath.org/) expression.
Read more about this new feature in [Generic OAuth Authentication](/auth/generic-oauth/) and make sure to check out the [JMESPath examples](/auth/generic-oauth/#jmespath-examples).
Read more about this new feature in [Generic OAuth Authentication]({{< relref "../auth/generic-oauth/" >}}) and make sure to check out the [JMESPath examples]({{< relref "../auth/generic-oauth/#jmespath-examples" >}}).
### Image renderer plugin
Since we announced the deprecation of PhantomJS and the new [Image Renderer Plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) in Grafana [6.4](/guides/whats-new-in-v6-4/#phantomjs-deprecation), we’ve received bug reports and valuable feedback.
Since we announced the deprecation of PhantomJS and the new [Image Renderer Plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) in Grafana [6.4]({{< relref "../guides/whats-new-in-v6-4/#phantomjs-deprecation" >}}), we’ve received bug reports and valuable feedback.
In Grafana 6.5 we’ve updated documentation to make it easier to understand how to install and troubleshoot possible problems. Read more about [Image Rendering](/administration/image_rendering/).
In Grafana 6.5 we’ve updated documentation to make it easier to understand how to install and troubleshoot possible problems. Read more about [Image Rendering]({{< relref "../administration/image_rendering/" >}}).
Please try the [Image Renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) and let us know what you think.
## Upgrading
See [upgrade notes](/installation/upgrading/#upgrading-to-v6-5).
See [upgrade notes]({{< relref "../installation/upgrading/#upgrading-to-v6-5" >}}).
## Changelog