Skip to content

N
nexpie-grafana-theme
Commit cbd81ffe by Robby Milo Committed by Marcus Efraimsson
Options

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

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).
parent 827688f1
Showing with 508 additions and 197 deletions
.circleci/config.yml
......@@ -1147,10 +1147,6 @@ workflows:
requires:
- grafana-docker-master
filters: *filter-only-master
- trigger-docs-update:
requires:
- end-to-end-test
filters: *filter-only-master
- release-next-packages:
requires:
- build-all
......
docs/sources/_index.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/administration/image_rendering.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/administration/provisioning.md 100644 → 100755
......@@ -15,7 +15,7 @@ In previous versions of Grafana, you could only use the API for provisioning dat
## Config File
Checkout the [configuration](/installation/configuration) page for more information on what you can configure in `grafana.ini`
Checkout the [configuration]({{< relref "../installation/configuration" >}}) page for more information on what you can configure in `grafana.ini`
### Config File Locations
......@@ -171,7 +171,7 @@ Since not all datasources have the same configuration settings we only have the
`{"authType":"keys","defaultRegion":"us-west-2","timeField":"@timestamp"}`
Secure json data is a map of settings that will be encrypted with [secret key](/installation/configuration/#secret-key) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional.
Secure json data is a map of settings that will be encrypted with [secret key]({{< relref "../installation/configuration/#secret-key" >}}) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional.
| Name | Type | Datasource | Description |
| ----| ---- | ---- | --- |
......
docs/sources/alerting/rules.md 100644 → 100755
......@@ -107,7 +107,7 @@ we plan to track state **per series** in a future release.
> Starting with Grafana v5.3 you can configure reminders to be sent for triggered alerts. This will send additional notifications
> when an alert continues to fire. If other series (like server2 in the example above) also cause the alert rule to fire they will
> be included in the reminder notification. Depending on what notification channel you're using you may be able to take advantage
> of this feature for identifying new/existing series causing alert to fire. [Read more about notification reminders here](/alerting/notifications/#send-reminders).
> of this feature for identifying new/existing series causing alert to fire. [Read more about notification reminders here]({{< relref "notifications/#send-reminders" >}}).
### No Data / Null values
......
docs/sources/archive.md
......@@ -12,12 +12,10 @@ weight = 200
Here you can find links to older versions of the documentation that might be better suited for your version
of Grafana.
- [Latest](http://docs.grafana.org)
- [Version 4.5](http://docs.grafana.org/v4.5)
- [Version 4.4](http://docs.grafana.org/v4.4)
- [Version 4.3](http://docs.grafana.org/v4.3)
- [Version 4.2](http://docs.grafana.org/v4.2)
- [Version 4.1](http://docs.grafana.org/v4.1)
- [Version 4.0](http://docs.grafana.org/v4.0)
- [Version 3.1](http://docs.grafana.org/v3.1)
- [Version 3.0](http://docs.grafana.org/v3.0)
- [Latest](/docs/grafana/latest/)
- [Version 4.5](/docs/grafana/v4.5)
- [Version 4.4](/docs/grafana/v4.4)
- [Version 4.3](/docs/grafana/v4.3)
- [Version 4.2](/docs/grafana/v4.2)
- [Version 4.1](/docs/grafana/v4.1)
- [Version 3.1](/docs/grafana/v3.1)
docs/sources/auth/auth-proxy.md 100644 → 100755
......@@ -238,7 +238,7 @@ headers = "Groups:X-WEBAUTH-GROUPS"
You use the `X-WEBAUTH-GROUPS` header to send the team information for each user. Specifically, the set of Grafana's group IDs that the user belongs to.
First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions]({{< relref "auth/team-sync.md#enable-synchronization-for-a-team" >}}) to add groups to a team within Grafana.
First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions]({{< relref "team-sync.md#enable-synchronization-for-a-team" >}}) to add groups to a team within Grafana.
Once that's done. You can verify your mappings by querying the API.
......@@ -296,7 +296,7 @@ curl -H "X-WEBAUTH-USER: leonard" -H "X-WEBAUTH-GROUPS: lokiteamOnExternalSystem
With this, the user `leonard` will be automatically placed into the Loki team as part of Grafana authentication.
[Learn more about Team Sync]({{< relref "auth/team-sync.md" >}})
[Learn more about Team Sync]({{< relref "team-sync.md" >}})
## Login token and session cookie
......@@ -306,4 +306,4 @@ a login token and cookie. You only have to configure your auth proxy to provide
Requests via other routes will be authenticated using the cookie.
Use settings `login_maximum_inactive_lifetime_days` and `login_maximum_lifetime_days` under `[auth]` to control session
lifetime. [Read more about login tokens](/auth/overview/#login-and-short-lived-tokens)
lifetime. [Read more about login tokens]({{< relref "overview/#login-and-short-lived-tokens" >}})
docs/sources/auth/enhanced_ldap.md 100644 → 100755
......@@ -12,9 +12,9 @@ weight = 3
# Enhanced LDAP Integration
> Enhanced LDAP Integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> Enhanced LDAP Integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
The enhanced LDAP integration adds additional functionality on top of the [existing LDAP integration]({{< relref "auth/ldap.md" >}}).
The enhanced LDAP integration adds additional functionality on top of the [existing LDAP integration]({{< relref "ldap.md" >}}).
## LDAP Group Synchronization for Teams
......@@ -28,7 +28,7 @@ Grafana keeps track of all synchronized users in teams and you can see which use
This mechanism allows Grafana to remove an existing synchronized user from a team when its LDAP group membership changes. This mechanism also enables you to manually add
a user as member of a team and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships.
[Learn more about Team Sync]({{< relref "auth/team-sync.md">}})
[Learn more about Team Sync]({{< relref "team-sync.md">}})
<div class="clearfix"></div>
......
docs/sources/auth/generic-oauth.md 100644 → 100755
......@@ -188,7 +188,7 @@ allowed_organizations =
allowed_organizations =
```
> Note: It's important to ensure that the [root_url](/installation/configuration/#root-url) in Grafana is set in your Azure Application Reply URLs (App -> Settings -> Reply URLs)
> Note: It's important to ensure that the [root_url]({{< relref "../installation/configuration/#root-url" >}}) in Grafana is set in your Azure Application Reply URLs (App -> Settings -> Reply URLs)
## Set up OAuth2 with Centrify
......
docs/sources/auth/github.md
......@@ -113,4 +113,4 @@ Your GitHub teams can be referenced in two ways:
Example: `@grafana/developers`
[Learn more about Team Sync]({{< relref "auth/team-sync.md" >}})
[Learn more about Team Sync]({{< relref "team-sync.md" >}})
docs/sources/auth/gitlab.md
......@@ -125,5 +125,5 @@ the correct teams.
Your GitLab groups can be referenced in the same way as `allowed_groups`, like `example` or `foo/bar`.
[Learn more about Team Sync]({{< relref "auth/enhanced_ldap.md" >}})
[Learn more about Team Sync]({{< relref "enhanced_ldap.md" >}})
docs/sources/auth/google.md
......@@ -31,7 +31,7 @@ First, you need to create a Google OAuth Client:
## Enable Google OAuth in Grafana
Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "installation/configuration.md#config-file-locations" >}}). For example:
Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}). For example:
```bash
[auth.google]
......
docs/sources/auth/ldap.md
......@@ -24,7 +24,7 @@ This means that you should be able to configure LDAP integration using any compl
## Enable LDAP
In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "installation/configuration.md" >}}) as well as specify the path to the LDAP
In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "../installation/configuration.md" >}}) as well as specify the path to the LDAP
specific configuration file (default: `/etc/grafana/ldap.toml`).
```bash
......@@ -334,7 +334,7 @@ Please inspect your Active Directory configuration and documentation to find the
## Troubleshooting
To troubleshoot and get more log info enable ldap debug logging in the [main config file]({{< relref "installation/configuration.md" >}}).
To troubleshoot and get more log info enable ldap debug logging in the [main config file]({{< relref "../installation/configuration.md" >}}).
```bash
[log]
......
docs/sources/auth/overview.md
......@@ -16,18 +16,18 @@ permissions and org memberships.
## OAuth Integrations
- [Google OAuth]({{< relref "auth/google.md" >}})
- [GitHub OAuth]({{< relref "auth/github.md" >}})
- [Gitlab OAuth]({{< relref "auth/gitlab.md" >}})
- [Generic OAuth]({{< relref "auth/generic-oauth.md" >}}) (Okta2, BitBucket, Azure, OneLogin, Auth0)
- [Google OAuth]({{< relref "google.md" >}})
- [GitHub OAuth]({{< relref "github.md" >}})
- [Gitlab OAuth]({{< relref "gitlab.md" >}})
- [Generic OAuth]({{< relref "generic-oauth.md" >}}) (Okta2, BitBucket, Azure, OneLogin, Auth0)
## LDAP integrations
- [LDAP Authentication]({{< relref "auth/ldap.md" >}}) (OpenLDAP, ActiveDirectory, etc)
- [LDAP Authentication]({{< relref "ldap.md" >}}) (OpenLDAP, ActiveDirectory, etc)
## Auth proxy
- [Auth Proxy]({{< relref "auth/auth-proxy.md" >}}) If you want to handle authentication outside Grafana using a reverse
- [Auth Proxy]({{< relref "auth-proxy.md" >}}) If you want to handle authentication outside Grafana using a reverse
proxy.
## Grafana Auth
......
docs/sources/auth/saml.md
......@@ -12,7 +12,7 @@ weight = 5
# SAML Authentication
> SAML Authentication integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> SAML Authentication integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
> Only available in Grafana v6.3+
......@@ -44,7 +44,7 @@ At the moment of writing, Grafana supports:
## Set up SAML Authentication
To use the SAML integration, you need to enable SAML in the [main config file]({{< relref "installation/configuration.md" >}}).
To use the SAML integration, you need to enable SAML in the [main config file]({{< relref "../installation/configuration.md" >}}).
```bash
[auth.saml]
......@@ -90,7 +90,7 @@ assertion_attribute_email = mail
Important to note:
- like any other Grafana configuration, use of [environment variables for these options is supported]({{< relref "installation/configuration.md#using-environment-variables" >}})
- like any other Grafana configuration, use of [environment variables for these options is supported]({{< relref "../installation/configuration.md#using-environment-variables" >}})
- only one form of configuration option is required. Using multiple forms, e.g. both `certificate` and `certificate_path` will result in an error
## Grafana Configuration
......@@ -170,7 +170,7 @@ An example is `assertion_attribute_name = "givenName"` where Grafana looks withi
## Troubleshooting
To troubleshoot and get more log info enable saml debug logging in the [main config file]({{< relref "installation/configuration.md" >}}).
To troubleshoot and get more log info enable saml debug logging in the [main config file]({{< relref "../installation/configuration.md" >}}).
```bash
[log]
......
docs/sources/auth/team-sync.md
......@@ -12,7 +12,7 @@ weight = 5
# Team Sync
> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
{{< docs-imagebox img="/img/docs/enterprise/team_members_ldap.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}}
......@@ -42,6 +42,6 @@ a user as member of a team and it will not be removed when the user signs in. Th
### Supported Providers
* [LDAP]({{< relref "auth/enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
* [GitHub OAuth]({{< relref "auth/github.md#team-sync-enterprise-only" >}})
* [Auth Proxy]({{< relref "auth/auth-proxy.md#team-sync-enterprise-only">}})
* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
* [GitHub OAuth]({{< relref "github.md#team-sync-enterprise-only" >}})
* [Auth Proxy]({{< relref "auth-proxy.md#team-sync-enterprise-only">}})
docs/sources/enterprise/_index.md 100644 → 100755
......@@ -23,29 +23,29 @@ ___
### Enhanced LDAP Integration
With Grafana Enterprise you can set up synchronization between LDAP Groups and Teams. [Learn More]({{< relref "auth/enhanced_ldap.md" >}}).
With Grafana Enterprise you can set up synchronization between LDAP Groups and Teams. [Learn More]({{< relref "../auth/enhanced_ldap.md" >}}).
### SAML Authentication
Enables your Grafana Enterprise users to authenticate with SAML. [Learn More]({{< relref "auth/saml.md" >}}).
Enables your Grafana Enterprise users to authenticate with SAML. [Learn More]({{< relref "../auth/saml.md" >}}).
### Team Sync
Team Sync allows you to setup synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. [Learn More]({{< relref "auth/team-sync.md" >}}).
Team Sync allows you to setup synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. [Learn More]({{< relref "../auth/team-sync.md" >}}).
Supported auth providers:
* [LDAP]({{< relref "auth/enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
* [GitHub OAuth]({{< relref "auth/github.md#team-sync-enterprise-only" >}})
* [Auth Proxy]({{< relref "auth/auth-proxy.md#team-sync-enterprise-only">}})
* [LDAP]({{< relref "../auth/enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}})
* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
### Data source permissions
Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "permissions/datasource_permissions.md" >}}).
Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "../permissions/datasource_permissions.md" >}}).
### Reporting
Reporting make it possible to take any Dashboard and generate a PDF report and setup a schedule to have it delivered. [Learn More]({{< relref "features/reporting.md" >}}).
Reporting make it possible to take any Dashboard and generate a PDF report and setup a schedule to have it delivered. [Learn More]({{< relref "../features/reporting.md" >}}).
### Premium Plugins
......
docs/sources/features/_index.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/features/datasources/azuremonitor.md 100644 → 100755
......@@ -155,7 +155,7 @@ Not all metrics returned by the Azure Monitor API have values. The Grafana data
### Azure Monitor Alerting
Grafana alerting is supported for the Azure Monitor service. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "alerting/rules.md" >}}).
Grafana alerting is supported for the Azure Monitor service. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "../../alerting/rules.md" >}}).
{{< docs-imagebox img="/img/docs/v60/azuremonitor-alerting.png" class="docs-image--no-shadow" caption="Azure Monitor Alerting" >}}
......@@ -216,7 +216,7 @@ Examples:
### Application Insights Alerting
Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "alerting/rules.md" >}}).
Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "../../alerting/rules.md" >}}).
{{< docs-imagebox img="/img/docs/v60/azuremonitor-alerting.png" class="docs-image--no-shadow" caption="Azure Monitor Alerting" >}}
......
docs/sources/features/datasources/cloudwatch.md 100644 → 100755
......@@ -306,7 +306,7 @@ Please see the AWS documentation for [Service Quotas](https://docs.aws.amazon.co
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/elasticsearch.md
......@@ -84,7 +84,7 @@ Identifier | Description
> Only available in Grafana v6.3+.
There are two parameters, `Message field name` and `Level field name`, that can optionally be configured from the data source settings page that determine
which fields will be used for log messages and log levels when visualizing logs in [Explore](/features/explore).
which fields will be used for log messages and log levels when visualizing logs in [Explore]({{< relref "../explore" >}}).
For example, if you're using a default setup of Filebeat for shipping logs to Elasticsearch the following configuration should work:
......@@ -172,7 +172,7 @@ Example dashboard:
## Annotations
[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
queries via the Dashboard menu / Annotations view. Grafana can query any Elasticsearch index
for annotation events.
......@@ -188,7 +188,7 @@ Tags | Optional field name to use for event tags (can be an array or a CSV strin
> Only available in Grafana v6.3+.
Querying and displaying log data from Elasticsearch is available via [Explore](/features/explore).
Querying and displaying log data from Elasticsearch is available via [Explore]({{< relref "../explore" >}}).
![](/img/docs/v63/elasticsearch_explore_logs.png)
......@@ -208,7 +208,7 @@ Optionally enter a lucene query into the query field to filter the log messages.
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/graphite.md 100644 → 100755
......@@ -163,7 +163,7 @@ Checkout the [Advanced Formatting Options section in the Variables]({{< relref "
## Annotations
[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
queries via the Dashboard menu / Annotations view.
Graphite supports two ways to query annotations. A regular metric query, for this you use the `Graphite query` textbox. A Graphite events query, use the `Graphite event tags` textbox,
......@@ -171,7 +171,7 @@ specify a tag or wildcard (leave empty should also work)
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/influxdb.md 100644 → 100755
......@@ -121,7 +121,7 @@ change the option `Format As` to `Table` if you want to show raw data in the `Ta
> Only available in Grafana v6.3+.
Querying and displaying log data from InfluxDB is available via [Explore](/features/explore).
Querying and displaying log data from InfluxDB is available via [Explore]({{< relref "../explore" >}}).
![](/img/docs/v63/influxdb_explore_logs.png)
......@@ -203,7 +203,7 @@ be applied to all your InfluxDB queries.
## Annotations
[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. Add annotation queries using the Annotations view in the Dashboard menu.
[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. Add annotation queries using the Annotations view in the Dashboard menu.
An example query:
......
docs/sources/features/datasources/loki.md 100644 → 100755
......@@ -18,7 +18,7 @@ weight = 6
> Viewing Loki data in dashboard panels is supported in Grafana v6.4+.
Grafana ships with built-in support for Loki, Grafana's log aggregation system.
Just add it as a data source and you are ready to query your log data in [Explore](/features/explore).
Just add it as a data source and you are ready to query your log data in [Explore]({{< relref "../explore" >}}).
## Adding the data source
......@@ -57,7 +57,7 @@ The new field with the link shown in log details:
## Querying Logs
Querying and displaying log data from Loki is available via [Explore](/features/explore), and with the [logs panel](/features/panels/logs/) in dashboards. Select the Loki data source, and then enter a log query to display your logs.
Querying and displaying log data from Loki is available via [Explore]({{< relref "../explore" >}}), and with the [logs panel]({{< relref "../panels/logs/" >}}) in dashboards. Select the Loki data source, and then enter a log query to display your logs.
### Log Queries
......@@ -125,7 +125,7 @@ The following filter types are currently supported:
## Live tailing
Loki supports Live tailing which displays logs in real-time. This feature is supported in [Explore](/features/explore/#loki-specific-features) and in dashboards with a Live toggle in the query editor.
Loki supports Live tailing which displays logs in real-time. This feature is supported in [Explore]({{< relref "../explore/#loki-specific-features" >}}) and in dashboards with a Live toggle in the query editor.
Note that Live Tailing relies on two Websocket connections: one between the browser and the Grafana server, and another between the Grafana server and the Loki server. If you run any reverse proxies, please configure them accordingly.
......@@ -144,7 +144,7 @@ log message you're interested in.
Instead of hard-coding things like server, application and sensor name in your metric queries, you can use variables in their place. Variables are shown as drop-down select boxes at the top of the dashboard. These drop-down boxes make it easy to change the data being displayed in your dashboard.
Checkout the [Templating](/reference/templating) documentation for an introduction to the templating feature and the different types of template variables.
Checkout the [Templating]({{< relref "../../reference/templating" >}}) documentation for an introduction to the templating feature and the different types of template variables.
## Annotations
......@@ -155,7 +155,7 @@ You can use any non-metric Loki query as a source for annotations. Log content w
## Configure the data source with provisioning
You can set up the data source via config files with Grafana's provisioning system.
You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here is an example:
......
docs/sources/features/datasources/mssql.md
......@@ -39,7 +39,7 @@ Name | Description
### Min time interval
A lower limit for the [$__interval](/reference/templating/#the-interval-variable) and [$__interval_ms](/reference/templating/#the-interval-ms-variable) variables.
A lower limit for the [$__interval]({{< relref "../../reference/templating/#the-interval-variable" >}}) and [$__interval_ms]({{< relref "../../reference/templating/#the-interval-ms-variable" >}}) variables.
Recommended to be set to write frequency, for example `1m` if your data is written every minute.
This option can also be overridden/configured in a dashboard panel under data source options. It's important to note that this value **needs** to be formatted as a
number followed by a valid time identifier, e.g. `1m` (1 minute) or `30s` (30 seconds). The following time identifiers are supported:
......@@ -374,7 +374,7 @@ Read more about variable formatting options in the [Variables]({{< relref "../..
## Annotations
[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view.
[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view.
**Columns:**
......@@ -579,7 +579,7 @@ conditions.
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/mysql.md 100644 → 100755
......@@ -41,7 +41,7 @@ Name | Description
### Min time interval
A lower limit for the [$__interval](/reference/templating/#the-interval-variable) and [$__interval_ms](/reference/templating/#the-interval-ms-variable) variables.
A lower limit for the [$__interval]({{< relref "../../reference/templating/#the-interval-variable" >}}) and [$__interval_ms]({{< relref "../../reference/templating/#the-interval-ms-variable" >}}) variables.
Recommended to be set to write frequency, for example `1m` if your data is written every minute.
This option can also be overridden/configured in a dashboard panel under data source options. It's important to note that this value **needs** to be formatted as a
number followed by a valid time identifier, e.g. `1m` (1 minute) or `30s` (30 seconds). The following time identifiers are supported:
......@@ -335,7 +335,7 @@ Read more about variable formatting options in the [Variables]({{< relref "../..
## Annotations
[Annotations]({{< relref "reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view.
[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view.
**Example query using time column with epoch values:**
......@@ -375,7 +375,7 @@ Time series queries should work in alerting conditions. Table formatted queries
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/opentsdb.md
......@@ -90,7 +90,7 @@ For details on OpenTSDB metric queries checkout the official [OpenTSDB documenta
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/postgres.md 100644 → 100755
......@@ -41,7 +41,7 @@ Name | Description
### Min time interval
A lower limit for the [$__interval](/reference/templating/#the-interval-variable) and [$__interval_ms](/reference/templating/#the-interval-ms-variable) variables.
A lower limit for the [$__interval]({{< relref "../../reference/templating/#the-interval-variable" >}}) and [$__interval_ms]({{< relref "../../reference/templating/#the-interval-ms-variable" >}}) variables.
Recommended to be set to write frequency, for example `1m` if your data is written every minute.
This option can also be overridden/configured in a dashboard panel under data source options. It's important to note that this value **needs** to be formatted as a
number followed by a valid time identifier, e.g. `1m` (1 minute) or `30s` (30 seconds). The following time identifiers are supported:
......@@ -339,7 +339,7 @@ Read more about variable formatting options in the [Variables]({{< relref "../..
## Annotations
[Annotations]({{< relref "reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view.
[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view.
**Example query using time column with epoch values:**
......@@ -380,7 +380,7 @@ conditions.
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/prometheus.md 100644 → 100755
......@@ -62,7 +62,7 @@ Open a graph in edit mode by click the title > Edit (or by pressing `e` key whil
The Prometheus datasource allows you to run "instant" queries, which queries only the latest value.
You can visualize the results in a table panel to see all available labels of a timeseries.
Instant query results are made up only of one datapoint per series but can be shown in the graph panel with the help of [series overrides](/features/panels/graph/#series-overrides).
Instant query results are made up only of one datapoint per series but can be shown in the graph panel with the help of [series overrides]({{< relref "../panels/graph/#series-overrides" >}}).
To show them in the graph as a latest value point, add a series override and select `Points > true`.
To show a horizontal line across the whole graph, add a series override and select `Transform > constant`.
......@@ -96,7 +96,7 @@ For details of _metric names_, _label names_ and _label values_ are please refer
> Support for `$__range`, `$__range_s` and `$__range_ms` only available from Grafana v5.3
It's possible to use some global built-in variables in query variables; `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`, see [Global built-in variables](/reference/templating/#global-built-in-variables) for more information. These can be convenient to use in conjunction with the `query_result` function when you need to filter variable queries since
It's possible to use some global built-in variables in query variables; `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`, see [Global built-in variables]({{< relref "../../reference/templating/#global-built-in-variables" >}}) for more information. These can be convenient to use in conjunction with the `query_result` function when you need to filter variable queries since
`label_values` function doesn't support queries.
Make sure to set the variable's `refresh` trigger to be `On Time Range Change` to get the correct instances when changing the time range on the dashboard.
......@@ -129,7 +129,7 @@ options are enabled, Grafana converts the labels from plain text to a regex comp
## Annotations
[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
queries via the Dashboard menu / Annotations view.
Prometheus supports two ways to query annotations.
......@@ -145,7 +145,7 @@ Since 4.6.0 Grafana exposes metrics for Prometheus on the `/metrics` endpoint. W
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here are some provisioning examples for this data source.
......
docs/sources/features/datasources/stackdriver.md 100644 → 100755
......@@ -202,7 +202,7 @@ Why two ways? The first syntax is easier to read and write but does not allow yo
{{< docs-imagebox img="/img/docs/v53/stackdriver_annotations_query_editor.png" max-width= "400px" class="docs-image--right" >}}
[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
queries via the Dashboard menu / Annotations view. Annotation rendering is expensive so it is important to limit the number of rows returned. There is no support for showing Stackdriver annotations and events yet but it works well with [custom metrics](https://cloud.google.com/monitoring/custom-metrics/) in Stackdriver.
With the query editor for annotations, you can select a metric and filters. The `Title` and `Text` fields support templating and can use data returned from the query. For example, the Title field could have the following text:
......@@ -224,7 +224,7 @@ Example Result: `monitoring.googleapis.com/uptime_check/http_status has this val
## Configure the data source with provisioning
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources)
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}})
Here is a provisioning example using the JWT (Service Account key file) authentication type.
......
docs/sources/features/explore/index.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/features/panels/graph.md 100644 → 100755
......@@ -187,7 +187,7 @@ Time regions allow you to highlight certain time regions of the graph to make it
The time range tab allows you to override the dashboard time range and specify a panel specific time.
Either through a relative from now time option or through a timeshift.
Panel time overrides and timeshift are described in more detail [here]({{< relref "reference/timerange.md#panel-time-overrides-timeshift" >}}).
Panel time overrides and timeshift are described in more detail [here]({{< relref "../../reference/timerange.md#panel-time-overrides-timeshift" >}}).
### Data link
......
docs/sources/features/panels/heatmap.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/features/panels/logs.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/features/panels/singlestat.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/features/panels/table_panel.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/features/reporting.md 100644 → 100755
......@@ -11,7 +11,7 @@ weight = 8
# Reporting
> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
> Only available in Grafana v6.4+
......@@ -27,7 +27,7 @@ With Reports there are a few things to keep in mind, most importantly, any chang
> SMTP must be configured for reports to be sent
We recommend using the new image rendering plugin with reporting as it supports a wider range of panels than the built-in image rendering. Read more about it [here]({{< relref "administration/image_rendering.md#grafana-image-renderer-plugin" >}})
We recommend using the new image rendering plugin with reporting as it supports a wider range of panels than the built-in image rendering. Read more about it [here]({{< relref "../administration/image_rendering.md#grafana-image-renderer-plugin" >}})
## Usage
......@@ -46,4 +46,4 @@ Currently only Organisation Admins can create reports. To get to report click on
## Debugging errors
If you have problems with the reporting feature you can enable debug logging by switching the logger to debug (`filters = report:debug`). Learn more about making configuration changes [here]({{< relref "installation/configuration.md#filters" >}}).
If you have problems with the reporting feature you can enable debug logging by switching the logger to debug (`filters = report:debug`). Learn more about making configuration changes [here]({{< relref "../installation/configuration.md#filters" >}}).
docs/sources/guides/basic_concepts.md 100644 → 100755
......@@ -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 100644 → 100755
......@@ -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 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/guides/whats-new-in-v4-6.md
......@@ -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
......@@ -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
......@@ -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 100644 → 100755
......@@ -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
......
docs/sources/http_api/_index.md
......@@ -2,7 +2,7 @@
title = "HTTP API"
description = "Grafana HTTP API"
keywords = ["grafana", "http", "documentation", "api", "overview"]
aliases = ["/http_api/overview"]
aliases = ["/overview"]
type = "docs"
[menu.docs]
name = "HTTP API"
......@@ -19,21 +19,21 @@ dashboards, creating users and updating data sources.
## Supported HTTP APIs:
* [Authentication API]({{< relref "http_api/auth.md" >}})
* [Dashboard API]({{< relref "http_api/dashboard.md" >}})
* [Dashboard Versions API]({{< relref "http_api/dashboard_versions.md" >}})
* [Dashboard Permissions API]({{< relref "http_api/dashboard_permissions.md" >}})
* [Folder API]({{< relref "http_api/folder.md" >}})
* [Folder Permissions API]({{< relref "http_api/folder_permissions.md" >}})
* [Folder/dashboard search API]({{< relref "http_api/folder_dashboard_search.md" >}})
* [Data Source API]({{< relref "http_api/data_source.md" >}})
* [Organization API]({{< relref "http_api/org.md" >}})
* [Snapshot API]({{< relref "http_api/snapshot.md" >}})
* [Annotations API]({{< relref "http_api/annotations.md" >}})
* [Alerting API]({{< relref "http_api/alerting.md" >}})
* [Alert Notification Channels API]({{< relref "http_api/alerting_notification_channels.md" >}})
* [User API]({{< relref "http_api/user.md" >}})
* [Team API]({{< relref "http_api/team.md" >}})
* [Admin API]({{< relref "http_api/admin.md" >}})
* [Preferences API]({{< relref "http_api/preferences.md" >}})
* [Other API]({{< relref "http_api/other.md" >}})
* [Authentication API]({{< relref "auth.md" >}})
* [Dashboard API]({{< relref "dashboard.md" >}})
* [Dashboard Versions API]({{< relref "dashboard_versions.md" >}})
* [Dashboard Permissions API]({{< relref "dashboard_permissions.md" >}})
* [Folder API]({{< relref "folder.md" >}})
* [Folder Permissions API]({{< relref "folder_permissions.md" >}})
* [Folder/dashboard search API]({{< relref "folder_dashboard_search.md" >}})
* [Data Source API]({{< relref "data_source.md" >}})
* [Organization API]({{< relref "org.md" >}})
* [Snapshot API]({{< relref "snapshot.md" >}})
* [Annotations API]({{< relref "annotations.md" >}})
* [Alerting API]({{< relref "alerting.md" >}})
* [Alert Notification Channels API]({{< relref "alerting_notification_channels.md" >}})
* [User API]({{< relref "user.md" >}})
* [Team API]({{< relref "team.md" >}})
* [Admin API]({{< relref "admin.md" >}})
* [Preferences API]({{< relref "preferences.md" >}})
* [Other API]({{< relref "other.md" >}})
docs/sources/http_api/alerting.md
......@@ -155,4 +155,4 @@ Content-Type: application/json
## Pause all alerts
See [Admin API]({{< relref "http_api/admin.md#pause-all-alerts" >}}).
See [Admin API]({{< relref "admin.md#pause-all-alerts" >}}).
docs/sources/http_api/auth.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/http_api/datasource_permissions.md
......@@ -11,7 +11,7 @@ parent = "http_api"
# Data Source Permissions API
> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
This API can be used to enable, disable, list, add and remove permissions for a data source.
......
docs/sources/http_api/external_group_sync.md
......@@ -11,7 +11,7 @@ parent = "http_api"
# External Group Synchronization API
> External Group Synchronization is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> External Group Synchronization is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
## Get External Groups
......
docs/sources/installation/_index.md
......@@ -12,13 +12,13 @@ weight = 1
## Installing Grafana
- [Requirements](requirements)
- [Installing on Debian / Ubuntu](debian)
- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](rpm)
- [Installing on macOS](mac)
- [Installing on Windows](windows)
- [Installing on Docker](docker)
- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](provisioning)
- [Requirements]({{< relref "requirements" >}})
- [Installing on Debian / Ubuntu]({{< relref "debian" >}})
- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)]({{< relref "rpm" >}})
- [Installing on macOS]({{< relref "mac" >}})
- [Installing on Windows]({{< relref "windows" >}})
- [Installing on Docker]({{< relref "docker" >}})
- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)]({{< relref "../administration/provisioning" >}})
- [Nightly Builds](https://grafana.com/grafana/download)
docs/sources/installation/configuration.md 100644 → 100755
......@@ -104,7 +104,7 @@ Directory where Grafana will automatically scan and look for plugins. Manually o
### provisioning
Folder that contains [provisioning](/administration/provisioning) config files that grafana will apply on startup. Dashboards will be reloaded when the json files changes
Folder that contains [provisioning]({{< relref "../administration/provisioning" >}}) config files that grafana will apply on startup. Dashboards will be reloaded when the json files changes
## [server]
......@@ -387,7 +387,7 @@ Set to `false` to disable the X-XSS-Protection header, which tells browsers to s
Set to `false` to prohibit users from being able to sign up / create
user accounts. Defaults to `false`. The admin user can still create
users from the [Grafana Admin Pages](../../reference/admin)
users from the [Grafana Admin Pages](/reference/admin)
### allow_org_create
......@@ -493,7 +493,7 @@ Number dashboard versions to keep (per dashboard). Default: `20`, Minimum: `1`.
## [dashboards.json]
> This have been replaced with dashboards [provisioning](/administration/provisioning) in 5.0+
> This have been replaced with dashboards [provisioning]({{< relref "../administration/provisioning" >}}) in 5.0+
### enabled
`true` or `false`. Is disabled by default.
......
docs/sources/installation/debian.md 100644 → 100755
......@@ -13,7 +13,7 @@ weight = 200
# Installing on Debian / Ubuntu
Read [Upgrading Grafana]({{< relref "installation/upgrading.md" >}}) for tips and guidance on updating an existing
Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing
installation.
## Download
......@@ -164,5 +164,5 @@ binary and the `public` folder is located).
## 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).
Then follow the instructions [here](/guides/getting_started/).
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 "configuration/#http-port" >}}).
Then follow the instructions [here]({{< relref "../guides/getting_started/" >}}).
docs/sources/installation/docker.md 100644 → 100755
......@@ -129,7 +129,7 @@ Replace `Dockerfile` in above example with `ubuntu.Dockerfile` to build a custom
> Only available in Grafana v6.5+ and experimental.
The [Grafana Image Renderer plugin](/administration/image_rendering/#grafana-image-renderer-plugin) does not
The [Grafana Image Renderer plugin]({{< relref "../administration/image_rendering/#grafana-image-renderer-plugin" >}}) does not
currently work if it is installed in Grafana docker image.
You can build a custom docker image by using the `GF_INSTALL_IMAGE_RENDERER_PLUGIN` build argument.
This will install additional dependencies needed for the Grafana Image Renderer plugin to run.
......@@ -292,5 +292,5 @@ Grafana Docker image now comes in two variants, one [Alpine](http://alpinelinux.
## 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).
Then follow the instructions [here](/guides/getting_started/).
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 "configuration/#http-port" >}}).
Then follow the instructions [here]({{< relref "../guides/getting_started/" >}}).
docs/sources/installation/mac.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/installation/requirements.md 100644 → 100755
......@@ -20,13 +20,15 @@ To run Grafana, you must have a supported operating system, hardware that meets
The following operating systems are supported for Grafana installation:
- [Debian / Ubuntu](/installation/debian)
- [RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](/installation/rpm)
- [macOS](/installation/mac)
- [Windows](/installation/windows)
- [Debian / Ubuntu]({{< relref "debian" >}})
- [RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)]({{< relref "rpm" >}})
- [macOS]({{< relref "mac" >}})
- [Windows]({{< relref "windows" >}})
While you can install Grafana on other operating systems, we do not recommend doing so and do not provide support for that use case.
Installation of Grafana on other operating systems is possible, but not supported. Please see the [building from source]({{< relref "../project/building_from_source/#building-grafana-from-source" >}}) guide for more information.
## Hardware recommendations
Grafana does not use a lot of resources and is very lightweight in use of memory and CPU.
......@@ -36,9 +38,9 @@ Minimum recommended CPU: 1
Some features might require more memory or CPUs. Features require more resources include:
- [Server-side rendering of images](/administration/image_rendering/#requirements)
- [Alerting](/alerting/rules/)
- Grafana data source proxy
- [Server side rendering of images]({{< relref "../administration/image_rendering/#requirements" >}})
- [Alerting]({{< relref "../alerting/rules" >}})
- Data source proxy
## Supported databases
......
docs/sources/installation/rpm.md 100644 → 100755
......@@ -13,7 +13,7 @@ weight = 300
# Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)
Read [Upgrading Grafana]({{< relref "installation/upgrading.md" >}}) for tips and guidance on updating an existing
Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing
installation.
## Download
......@@ -158,10 +158,10 @@ those options.
### Adding data sources
- [Graphite]({{< relref "features/datasources/graphite.md" >}})
- [InfluxDB]({{< relref "features/datasources/influxdb.md" >}})
- [OpenTSDB]({{< relref "features/datasources/opentsdb.md" >}})
- [Prometheus]({{< relref "features/datasources/prometheus.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" >}})
### Server side image rendering
......@@ -193,5 +193,5 @@ binary and the `public` folder is located).
## 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).
Then follow the instructions [here](/guides/getting_started/).
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 "configuration/#http-port" >}}).
Then follow the instructions [here]({{< relref "../guides/getting_started/" >}}).
docs/sources/installation/security.md
......@@ -20,7 +20,7 @@ To prevent this type of exploitation from happening we explain a couple of diffe
### Configure Grafana to only allow certain IP addresses/hostnames to be used as data source url
You can configure Grafana to only allow certain IP addresses/hostnames to be used as data source url and by that proxied through the Grafana data source proxy. See [data_source_proxy_whitelist](/installation/configuration/#data-source-proxy-whitelist) for usage instructions.
You can configure Grafana to only allow certain IP addresses/hostnames to be used as data source url and by that proxied through the Grafana data source proxy. See [data_source_proxy_whitelist]({{< relref "configuration/#data-source-proxy-whitelist" >}}) for usage instructions.
### Firewall rules
......@@ -36,5 +36,5 @@ Important to understand that users with Viewer role can still issue any possible
There are a couple of ways you can restrict data source query access:
- Create multiple data sources with some restrictions added in data source config that restrict access (like database name or credentials). Then use the [Data Source Permissions]({{< relref "permissions/datasource_permissions.md" >}}) Enterprise feature to restrict user access to the data source in Grafana.
- Create multiple data sources with some restrictions added in data source config that restrict access (like database name or credentials). Then use the [Data Source Permissions]({{< relref "../permissions/datasource_permissions.md" >}}) Enterprise feature to restrict user access to the data source in Grafana.
- Create a separate Grafana organization and in that organization create a separate data source. Make sure the data source has some option/user/credentials setting that limits access to a subset of the data. Not all data sources have an option to limit access.
docs/sources/installation/troubleshooting.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/installation/upgrading.md 100644 → 100755
......@@ -108,7 +108,7 @@ as this will make upgrades easier without risking losing your config changes.
## Upgrading from 1.x
[Migrating from 1.x to 2.x]({{< relref "installation/migrating_to2.md" >}})
[Migrating from 1.x to 2.x]({{< relref "migrating_to2.md" >}})
## Upgrading from 2.x
......@@ -120,7 +120,7 @@ The dashboard grid layout engine has changed. All dashboards will be automatical
positioning system when you load them in v5. Dashboards saved in v5 will not work in older versions of Grafana. Some
external panel plugins might need to be updated to work properly.
For more details on the new panel positioning system, [click here]({{< relref "reference/dashboard.md#panel-size-position" >}})
For more details on the new panel positioning system, [click here]({{< relref "../reference/dashboard.md#panel-size-position" >}})
## Upgrading to v5.2
......@@ -133,7 +133,7 @@ If you're using systemd and have a large amount of annotations consider temporar
## Upgrading to v6.0
If you have text panels with script tags they will no longer work due to a new setting that per default disallow unsanitized HTML.
Read more [here](/installation/configuration/#disable-sanitize-html) about this new setting.
Read more [here]({{< relref "configuration/#disable-sanitize-html" >}}) about this new setting.
### Authentication and security
......@@ -170,15 +170,15 @@ will keep working with unencrypted passwords. If you want to migrate to encrypte
you can do that by:
- For data sources created through UI, you need to go to data source config, re enter the password or basic auth
password and save the data source.
password and save the data source.
- For data sources created by provisioning, you need to update your config file and use secureJsonData.password or
secureJsonData.basicAuthPassword field. See [provisioning docs](/administration/provisioning) for example of current
configuration.
secureJsonData.basicAuthPassword field. See [provisioning docs]({{< relref "../administration/provisioning" >}}) for example of current
configuration.
### Embedding Grafana
If you're embedding Grafana in a `<frame>`, `<iframe>`, `<embed>` or `<object>` on a different website it will no longer work due to a new setting
that per default instructs the browser to not allow Grafana to be embedded. Read more [here](/installation/configuration/#allow-embedding) about
that per default instructs the browser to not allow Grafana to be embedded. Read more [here]({{< relref "configuration/#allow-embedding" >}}) about
this new setting.
### Session storage is no longer used
......
docs/sources/installation/windows.md 100644 → 100755
......@@ -14,7 +14,7 @@ Description | Download
------------ | -------------
Latest stable package for Windows | [x64](https://grafana.com/grafana/download?platform=windows)
Read [Upgrading Grafana]({{< relref "installation/upgrading.md" >}}) for tips and guidance on updating an existing
Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing
installation.
## Configure
......@@ -44,7 +44,7 @@ Read more about the [configuration options]({{< relref "configuration.md" >}}).
## Logging in for the first time
To run Grafana open your browser and go to the port you configured above, e.g. http://localhost:8080/.
Then follow the instructions [here](/guides/getting_started/).
Then follow the instructions [here]({{< relref "../guides/getting_started/" >}}).
## Building on Windows
......
docs/sources/menu.yaml 0 → 100644
- name: Installation
link: /installation/
children:
- name: Requirements
link: /installation/requirements/
- name: Installing on Ubuntu / Debian
link: /installation/debian/
- name: Installing on Centos / Redhat
link: /installation/rpm/
- name: Installing on Windows
link: /installation/windows/
- name: Installing on macOS
link: /installation/mac/
- name: Installing using Docker
link: /installation/docker/
- name: Building from source
link: /project/building_from_source/
- name: Upgrading
link: /installation/upgrading/
- name: Administration
link: /administration/
children:
- name: Configuration
link: /installation/configuration/
- name: Security
link: /installation/security/
- name: Authentication
link: /auth/
children:
- link: /auth/overview/
name: Overview
- link: /auth/auth-proxy/
name: Auth Proxy
- link: /auth/ldap/
name: LDAP
- link: /auth/enhanced_ldap/
name: Enhanced LDAP
- link: /auth/generic-oauth/
name: Generic OAuth
- link: /auth/google/
name: Google
- link: /auth/github/
name: GitHub
- link: /auth/gitlab/
name: GitLab
- link: /auth/saml/
name: SAML
- link: /auth/team-sync/
name: Team Sync
- name: Permissions
link: /permissions/
children:
- link: /permissions/overview/
name: Overview
- link: /permissions/organization_roles/
name: Organization Roles
- link: /permissions/dashboard_folder_permissions/
name: Dashboard and Folder
- link: /permissions/datasource_permissions/
name: Datasource
- name: Grafana CLI
link: /administration/cli/
- name: Image Rendering
link: /administration/image_rendering/
- name: Internal metrics
link: /administration/metrics/
- name: Provisioning
link: /administration/provisioning/
- name: Troubleshooting
link: /installation/troubleshooting/
- name: Getting Started
link: /guides/
children:
- name: Getting Started
link: /guides/getting_started/
- name: Basic Concepts
link: /guides/basic_concepts/
- name: Glossary
link: /guides/glossary/
- name: Screencasts
link: /tutorials/screencasts/
- name: Features
link: /features/
children:
- name: Panels
link: /features/panels/
children:
- link: /features/panels/graph/
name: Graph
- link: /features/panels/logs/
name: Logs
- link: /features/panels/singlestat/
name: Singlestat
- link: /features/panels/table_panel/
name: Table
- link: /features/panels/heatmap/
name: Heatmap
- link: /features/panels/alertlist/
name: Alert list
- link: /features/panels/dashlist/
name: Dashboard list
- link: /features/panels/text/
name: Text
- name: Dashboard Features
link: /features/dashboard/
children:
- link: /reference/templating/
name: Variables
- link: /reference/annotations/
name: Annotations
- link: /reference/dashboard_folders/
name: Folders
- link: /reference/playlist/
name: Playlist
- link: /reference/search/
name: Search
- link: /reference/share_dashboard/
name: Sharing a Dashboard
- link: /reference/share_panel/
name: Sharing a Panel
- link: /reference/timerange/
name: Time Range
- link: /reference/export_import/
name: Export and Import
- link: /reference/scripting/
name: Scripted Dashboards
- link: /reference/dashboard_history/
name: Dashboard Version History
- link: /reference/dashboard/
name: JSON Model
- name: Data Sources
link: /features/datasources/
children:
- link: /features/datasources/graphite/
name: Graphite
- link: /features/datasources/prometheus/
name: Prometheus
- link: /features/datasources/influxdb/
name: InfluxDB
- link: /features/datasources/elasticsearch/
name: Elasticsearch
- link: /features/datasources/stackdriver/
name: Google Stackdriver
- link: /features/datasources/cloudwatch/
name: AWS Cloudwatch
- link: /features/datasources/azuremonitor/
name: Azure Monitor
- link: /features/datasources/loki/
name: Loki
- link: /features/datasources/mysql/
name: MySQL
- link: /features/datasources/postgres/
name: PostgreSQL
- link: /features/datasources/mssql/
name: Microsoft SQL Server
- link: /features/datasources/opentsdb/
name: OpenTSDB
- link: /features/datasources/mixed/
name: MixedData
- link: /features/datasources/testdata/
name: TestData
- name: Explore
link: /features/explore/
- name: Alerting
link: /alerting/
children:
- link: /alerting/rules/
name: Engine and Rules
- link: /alerting/metrics/
name: Metrics
- link: /alerting/notifications/
name: Notifications
- name: Keyboard Shortcuts
link: /features/shortcuts/
- name: What's New In Grafana
link: /whatsnew/
children:
- name: Version 6.5
link: /guides/whats-new-in-v6-5/
- name: Version 6.4
link: /guides/whats-new-in-v6-4/
- name: Version 6.3
link: /guides/whats-new-in-v6-3/
- name: Version 6.2
link: /guides/whats-new-in-v6-2/
- name: Version 6.1
link: /guides/whats-new-in-v6-1/
- name: Version 6.0
link: /guides/whats-new-in-v6-0/
- name: Version 5.4
link: /guides/whats-new-in-v5-4/
- name: Version 5.3
link: /guides/whats-new-in-v5-3/
- name: Version 5.2
link: /guides/whats-new-in-v5-2/
- name: Version 5.1
link: /guides/whats-new-in-v5-1/
- name: Version 5.0
link: /guides/whats-new-in-v5/
- name: Version 4.6
link: /guides/whats-new-in-v4-6/
- name: Version 4.5
link: /guides/whats-new-in-v4-5/
- name: Version 4.4
link: /guides/whats-new-in-v4-4/
- name: Version 4.3
link: /guides/whats-new-in-v4-3/
- name: Version 4.2
link: /guides/whats-new-in-v4-2/
- name: Version 4.1
link: /guides/whats-new-in-v4-1/
- name: Version 4.0
link: /guides/whats-new-in-v4/
- name: Version 3.1
link: /guides/whats-new-in-v3-1/
- name: Version 3.0
link: /guides/whats-new-in-v3/
- name: Tutorials
link: /tutorials/
children:
- name: Running Grafana behind a reverse proxy
link: /installation/behind_proxy/
- name: 'API Tutorial: How To Create API Tokens And Dashboards For A Specific Organization'
link: /tutorials/api_org_token_howto/
- name: Grafana with IIS Reverse Proxy on Windows
link: /tutorials/iis/
- name: How To integrate Hubot and Grafana
link: /tutorials/hubot_howto/
- name: Setup Grafana for High availability
link: /tutorials/ha_setup/
- name: Plugins
link: /plugins/
children:
- name: Installing Plugins
link: /plugins/installation/
- name: Developing Plugins
link: /plugins/developing/
children:
- link: /plugins/developing/development/
name: Developer Guide
- link: /plugins/developing/code-styleguide/
name: Plugin Code Styleguide
- link: /plugins/developing/plugin-review-guidelines/
name: Plugin Review Guidelines
- link: /plugins/developing/auth-for-datasources/
name: Authentication for Datasource Plugins
- link: /plugins/developing/defaults-and-editor-mode/
name: Plugin Defaults and Editor Mode
- link: /plugins/developing/apps/
name: Developing App Plugins
- link: /plugins/developing/panels/
name: Developing Panel Plugins
- link: /plugins/developing/backend-plugins-guide/
name: Developing Backend Plugins
- link: /plugins/developing/datasources/
name: Developing Datasource Plugins
- link: /plugins/developing/snapshot-mode/
name: Snapshot Mode
- link: /plugins/developing/plugin.json/
name: plugin.json Schema
- name: HTTP API
link: /http_api/
children:
- name: Admin
link: /http_api/admin/
- name: Alerting
link: /http_api/alerting/
- name: Alerting Notification Channels
link: /http_api/alerting_notification_channels/
- name: Annotations
link: /http_api/annotations/
- name: Authentication HTTP API
link: /http_api/auth/
- name: Dashboard
link: /http_api/dashboard/
- name: Dashboard Permissions
link: /http_api/dashboard_permissions/
- name: Dashboard Versions
link: /http_api/dashboard_versions/
- name: Data source
link: /http_api/data_source/
- name: Datasource Permissions
link: /http_api/datasource_permissions/
- name: External Group Sync
link: /http_api/external_group_sync/
- name: Folder
link: /http_api/folder/
- name: Folder Permissions
link: /http_api/folder_permissions/
- name: Folder/dashboard search
link: /http_api/folder_dashboard_search/
- name: Organization
link: /http_api/org/
- name: Other
link: /http_api/other/
- name: Playlist
link: /http_api/playlist/
- name: Preferences
link: /http_api/preferences/
- name: Snapshot
link: /http_api/snapshot/
- name: Teams
link: /http_api/team/
- name: Users
link: /http_api/user/
- name: Contribute
link: /contribute/
children:
- name: Contributor License Agreement (CLA)
link: /contribute/cla/
- name: Grafana Enterprise
link: /enterprise/
- name: Docs Archive
link: /archive/
\ No newline at end of file
docs/sources/permissions/datasource_permissions.md
......@@ -12,7 +12,7 @@ weight = 4
# Data Source Permissions
> Data source permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> Data source permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
Data source permissions allows you to restrict access for users to query a data source. For each data source there is
a permission page that makes it possible to enable permissions and restrict query permissions to specific
......@@ -27,7 +27,7 @@ that organization. For example a user with `Viewer` role can still issue any pos
those queries that exist on dashboards he/she has access to.
When permissions are enabled for a data source in an organization you will restrict admin and query access for that
data source to [admin users](/permissions/organization_roles/#admin-role) in that organization.
data source to [admin users]({{< relref "../permissions/organization_roles/#admin-role" >}}) in that organization.
**To enable permissions for a data source:**
......
docs/sources/permissions/organization_roles.md
......@@ -28,7 +28,7 @@ Can do everything scoped to the organization. For example:
- Can create and modify dashboards and alert rules. This can be disabled on specific folders and dashboards.
- **Cannot** create or edit data sources nor invite new users.
This role can be tweaked via Grafana server setting [editors_can_admin]({{< relref "installation/configuration.md#editors_can_admin" >}}). If you set this to true users
This role can be tweaked via Grafana server setting [editors_can_admin]({{< relref "../installation/configuration.md#editors_can_admin" >}}). If you set this to true users
with **Editor** can also administrate dashboards, folders and teams they create. Useful for enabling self organizing teams.
## Viewer Role
......@@ -36,6 +36,6 @@ with **Editor** can also administrate dashboards, folders and teams they create.
- View any dashboard. This can be disabled on specific folders and dashboards.
- **Cannot** create or edit dashboards nor data sources.
This role can be tweaked via Grafana server setting [viewers_can_edit]({{< relref "installation/configuration.md#viewers-can-edit" >}}). If you set this to true users
This role can be tweaked via Grafana server setting [viewers_can_edit]({{< relref "../installation/configuration.md#viewers-can-edit" >}}). If you set this to true users
with **Viewer** can also make transient dashboard edits, meaning they can modify panels and queries but not save the changes (nor create new dashboards).
Useful for public Grafana installations where you want anonymous users to be able to edit panels and queries but not save or create new dashboards.
docs/sources/permissions/overview.md
......@@ -27,16 +27,16 @@ This admin flag makes a user a `Super Admin`. This means they can access the `Se
## Organization Roles
Users can be belong to one or more organizations. A user's organization membership is tied to a role that defines what the user is allowed to do
in that organization. Learn more about [Organization Roles]({{< relref "permissions/organization_roles.md" >}}).
in that organization. Learn more about [Organization Roles]({{< relref "organization_roles.md" >}}).
## Dashboard and Folder Permissions
Dashboard and folder permissions allows you to remove the default role based permissions for Editors and Viewers and assign permissions to specific **Users** and **Teams**. Learn more about [Dashboard and Folder Permissions]({{< relref "permissions/dashboard_folder_permissions.md" >}}).
Dashboard and folder permissions allows you to remove the default role based permissions for Editors and Viewers and assign permissions to specific **Users** and **Teams**. Learn more about [Dashboard and Folder Permissions]({{< relref "dashboard_folder_permissions.md" >}}).
## Data source permissions
Per default, a data source in an organization can be queried by any user in that organization. For example a user with `Viewer` role can still
issue any possible query to a data source, not just those queries that exist on dashboards he/she has access to.
Data source permissions allows you to change the default permissions for data sources and restrict query permissions to specific **Users** and **Teams**. Read more about [data source permissions]({{< relref "permissions/datasource_permissions.md" >}}).
Data source permissions allows you to change the default permissions for data sources and restrict query permissions to specific **Users** and **Teams**. Read more about [data source permissions]({{< relref "datasource_permissions.md" >}}).
docs/sources/project/building_from_source.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/reference/annotations.md
......@@ -17,7 +17,7 @@ you can get event description and event tags. The text field can include links t
## Native annotations
Grafana v4.6+ comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the [HTTP API]({{< relref "http_api/annotations.md" >}}).
Grafana v4.6+ comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the [HTTP API]({{< relref "annotations.md" >}}).
## Adding annotations
......@@ -69,10 +69,10 @@ to show.
The annotation query options are different for each data source.
- [Graphite annotation queries]({{< relref "features/datasources/graphite.md#annotations" >}})
- [Elasticsearch annotation queries]({{< relref "features/datasources/elasticsearch.md#annotations" >}})
- [InfluxDB annotation queries]({{< relref "features/datasources/influxdb.md#annotations" >}})
- [Prometheus annotation queries]({{< relref "features/datasources/prometheus.md#annotations" >}})
- [MySQL annotation queries]({{< relref "features/datasources/mysql.md#annotations" >}})
- [Postgres annotation queries]({{< relref "features/datasources/postgres.md#annotations" >}})
- [Loki annotation queries]({{< relref "features/datasources/loki.md#annotations" >}})
- [Graphite annotation queries]({{< relref "../features/datasources/graphite.md#annotations" >}})
- [Elasticsearch annotation queries]({{< relref "../features/datasources/elasticsearch.md#annotations" >}})
- [InfluxDB annotation queries]({{< relref "../features/datasources/influxdb.md#annotations" >}})
- [Prometheus annotation queries]({{< relref "../features/datasources/prometheus.md#annotations" >}})
- [MySQL annotation queries]({{< relref "../features/datasources/mysql.md#annotations" >}})
- [Postgres annotation queries]({{< relref "../features/datasources/postgres.md#annotations" >}})
- [Loki annotation queries]({{< relref "../features/datasources/loki.md#annotations" >}})
docs/sources/reference/share_panel.md
......@@ -32,7 +32,7 @@ https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=156871968017
You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use.
> *Notice* This sharing require either anonymous access or setting [cookie_samesite]({{< relref "installation/configuration.md#cookie-samesite" >}}) to none
> *Notice* This sharing require either anonymous access or setting [cookie_samesite]({{< relref "../installation/configuration.md#cookie-samesite" >}}) to none
Example:
......
docs/sources/reference/templating.md
......@@ -236,11 +236,11 @@ demo.robustperception.io:9100
The query expressions are different for each data source.
- [Graphite templating queries]({{< relref "features/datasources/graphite.md#templating" >}})
- [Elasticsearch templating queries]({{< relref "features/datasources/elasticsearch.md#templating" >}})
- [InfluxDB templating queries]({{< relref "features/datasources/influxdb.md#templating" >}})
- [Prometheus templating queries]({{< relref "features/datasources/prometheus.md#templating" >}})
- [OpenTSDB templating queries]({{< relref "features/datasources/opentsdb.md#templating" >}})
- [Graphite templating queries]({{< relref "../features/datasources/graphite.md#templating" >}})
- [Elasticsearch templating queries]({{< relref "../features/datasources/elasticsearch.md#templating" >}})
- [InfluxDB templating queries]({{< relref "../features/datasources/influxdb.md#templating" >}})
- [Prometheus templating queries]({{< relref "../features/datasources/prometheus.md#templating" >}})
- [OpenTSDB templating queries]({{< relref "../features/datasources/opentsdb.md#templating" >}})
One thing to note is that query expressions can contain references to other variables and in effect create linked variables.
Grafana will detect this and automatically refresh a variable when one of it's containing variables change.
......
docs/sources/reference/timerange.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/tutorials/_index.md 100644 → 100755
......@@ -12,7 +12,7 @@ This section of the docs contains a series for tutorials and stack setup guides.
## Articles
- [Running Grafana behind a reverse proxy]({{< relref "behind_proxy.md" >}})
- [Running Grafana behind a reverse proxy]({{< relref "../installation/behind_proxy.md" >}})
- [API Tutorial: How To Create API Tokens And Dashboards For A Specific Organization]({{< relref "api_org_token_howto.md" >}})
- [How to Use IIS with URL Rewrite as a Reverse Proxy for Grafana on Windows]({{< relref "iis.md" >}})
- [How to integrate Hubot with Grafana]({{< relref "hubot_howto.md" >}})
......
docs/sources/tutorials/api_org_token_howto.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/tutorials/ha_setup.md 100644 → 100755
File mode changed from 100644 to 100755
docs/sources/tutorials/hubot_howto.md 100644 → 100755
File mode changed from 100644 to 100755
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment