From e07d0ae452f962b31b3b2265193a271de169f42d Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Tue, 30 Jun 2020 14:18:38 -0700 Subject: [PATCH] Docs: Reorganize reference topics (#25915) * moved annotations.md * Update annotations.md * moved dashboard_folders.md * moved dashboard_history.md * moved playlist.md * moved search.md --- docs/sources/{reference => dashboards}/annotations.md | 1 + .../{reference => dashboards}/dashboard_folders.md | 1 + .../{reference => dashboards}/dashboard_history.md | 1 + docs/sources/{reference => dashboards}/playlist.md | 1 + docs/sources/{reference => dashboards}/search.md | 1 + .../developers/plugins/add-support-for-annotations.md | 6 +++--- docs/sources/features/dashboard/dashboards.md | 2 +- docs/sources/features/datasources/cloudmonitoring.md | 2 +- docs/sources/features/datasources/elasticsearch.md | 2 +- docs/sources/features/datasources/graphite.md | 2 +- docs/sources/features/datasources/influxdb.md | 2 +- docs/sources/features/datasources/mssql.md | 2 +- docs/sources/features/datasources/mysql.md | 2 +- docs/sources/features/datasources/postgres.md | 2 +- docs/sources/features/datasources/prometheus.md | 2 +- docs/sources/getting-started/what-is-grafana.md | 2 +- docs/sources/guides/whats-new-in-v4-6.md | 2 +- docs/sources/guides/whats-new-in-v5-3.md | 6 +++--- docs/sources/menu.yaml | 10 +++++----- 19 files changed, 27 insertions(+), 22 deletions(-) rename docs/sources/{reference => dashboards}/annotations.md (98%) rename docs/sources/{reference => dashboards}/dashboard_folders.md (97%) rename docs/sources/{reference => dashboards}/dashboard_history.md (97%) rename docs/sources/{reference => dashboards}/playlist.md (99%) rename docs/sources/{reference => dashboards}/search.md (97%) mode change 100755 => 100644 docs/sources/features/datasources/cloudmonitoring.md diff --git a/docs/sources/reference/annotations.md b/docs/sources/dashboards/annotations.md similarity index 98% rename from docs/sources/reference/annotations.md rename to docs/sources/dashboards/annotations.md index 547452cc6f3..3a0e02f6c4c 100644 --- a/docs/sources/reference/annotations.md +++ b/docs/sources/dashboards/annotations.md @@ -2,6 +2,7 @@ title = "Annotations" keywords = ["grafana", "annotations", "documentation", "guide"] type = "docs" +aliases = ["/docs/grafana/latest/reference/annotations/"] [menu.docs] name = "Annotations" parent = "dashboard_features" diff --git a/docs/sources/reference/dashboard_folders.md b/docs/sources/dashboards/dashboard_folders.md similarity index 97% rename from docs/sources/reference/dashboard_folders.md rename to docs/sources/dashboards/dashboard_folders.md index 9a0de93d30b..0883b54a7a3 100644 --- a/docs/sources/reference/dashboard_folders.md +++ b/docs/sources/dashboards/dashboard_folders.md @@ -2,6 +2,7 @@ title = "Dashboard Folders" keywords = ["grafana", "dashboard", "dashboard folders", "folder", "folders", "documentation", "guide"] type = "docs" +aliases = ["/docs/grafana/latest/reference/dashboard_folders/"] [menu.docs] name = "Folders" parent = "dashboard_features" diff --git a/docs/sources/reference/dashboard_history.md b/docs/sources/dashboards/dashboard_history.md similarity index 97% rename from docs/sources/reference/dashboard_history.md rename to docs/sources/dashboards/dashboard_history.md index 18e700dfdbd..741986f0da4 100644 --- a/docs/sources/reference/dashboard_history.md +++ b/docs/sources/dashboards/dashboard_history.md @@ -2,6 +2,7 @@ title = "Dashboard Version History" keywords = ["grafana", "dashboard", "documentation", "version", "history"] type = "docs" +aliases = ["/docs/grafana/latest/reference/dashboard_history/"] [menu.docs] name = "Dashboard Version History" parent = "dashboard_features" diff --git a/docs/sources/reference/playlist.md b/docs/sources/dashboards/playlist.md similarity index 99% rename from docs/sources/reference/playlist.md rename to docs/sources/dashboards/playlist.md index 747bab83210..21ff4a32252 100644 --- a/docs/sources/reference/playlist.md +++ b/docs/sources/dashboards/playlist.md @@ -2,6 +2,7 @@ title = "Playlist" keywords = ["grafana", "dashboard", "documentation", "playlist"] type = "docs" +aliases = ["/docs/grafana/latest/reference/playlist/"] [menu.docs] parent = "dashboard_features" identifier = "feature_playlist" diff --git a/docs/sources/reference/search.md b/docs/sources/dashboards/search.md similarity index 97% rename from docs/sources/reference/search.md rename to docs/sources/dashboards/search.md index a21e356a5d8..d478963291f 100644 --- a/docs/sources/reference/search.md +++ b/docs/sources/dashboards/search.md @@ -2,6 +2,7 @@ title = "Search" keywords = ["grafana", "dashboard", "documentation", "search"] type = "docs" +aliases =["/docs/grafana/latest/reference/search/"] [menu.docs] parent = "dashboard_features" weight = 5 diff --git a/docs/sources/developers/plugins/add-support-for-annotations.md b/docs/sources/developers/plugins/add-support-for-annotations.md index fe353f51376..ff32752798d 100644 --- a/docs/sources/developers/plugins/add-support-for-annotations.md +++ b/docs/sources/developers/plugins/add-support-for-annotations.md @@ -5,11 +5,11 @@ type = "docs" # Add support for annotations -This guide explains how to add support for [annotations]({{< relref "../../reference/annotations.md" >}}) to an existing data source plugin. +This guide explains how to add support for [annotations]({{< relref "../../dashboards/annotations.md" >}}) to an existing data source plugin. This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "../../../../../tutorials/build-a-data-source-plugin.md" >}}). -Data sources in Grafana can support [Annotations]({{< relref "../../reference/annotations.md" >}}) by handling _annotation queries_. +Data sources in Grafana can support [Annotations]({{< relref "../../dashboards/annotations.md" >}}) by handling _annotation queries_. Handling annotation queries is similar to how you'd handle a metrics query. The difference is that instead of returning [data frames]({{< relref "data-frames.md" >}}), an annotation query returns _annotation events_. @@ -65,7 +65,7 @@ async annotationQuery(options: AnnotationQueryRequest): Promise}}) have a start and end time. This can for example be used to annotate maintenance windows or downtime. +[Region annotations]({{< relref "../../dashboards/annotations.md#adding-regions-events" >}}) have a start and end time. This can for example be used to annotate maintenance windows or downtime. To return a region annotation, set the `timeEnd`, and `isRegion` properties. diff --git a/docs/sources/features/dashboard/dashboards.md b/docs/sources/features/dashboard/dashboards.md index c663c05ce88..e0cddc7fecc 100644 --- a/docs/sources/features/dashboard/dashboards.md +++ b/docs/sources/features/dashboard/dashboards.md @@ -43,7 +43,7 @@ The time period for the dashboard can be controlled by the [Time range controls] Dashboards can use [templating]({{< relref "../../variables/templates-and-variables.md" >}}) to make them more dynamic and interactive. -Dashboards can use [annotations]({{< relref "../../reference/annotations.md" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events. +Dashboards can use [annotations]({{< relref "../../dashboards/annotations.md" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events. Dashboards can be [shared]({{< relref "../../reference/share_dashboard.md" >}}) easily in a variety of ways. diff --git a/docs/sources/features/datasources/cloudmonitoring.md b/docs/sources/features/datasources/cloudmonitoring.md old mode 100755 new mode 100644 index db1e8389cce..129a0c698ed --- a/docs/sources/features/datasources/cloudmonitoring.md +++ b/docs/sources/features/datasources/cloudmonitoring.md @@ -265,7 +265,7 @@ Why two ways? The first syntax is easier to read and write but does not allow yo {{< docs-imagebox img="/img/docs/v71/cloudmonitoring_annotations_query_editor.png" max-width= "400px" class="docs-image--right" >}} -[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../dashboards/annotations.md" >}}) allow 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 Google Cloud Monitoring annotations and events yet but it works well with [custom metrics](https://cloud.google.com/monitoring/custom-metrics/) in Google Cloud Monitoring. 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: diff --git a/docs/sources/features/datasources/elasticsearch.md b/docs/sources/features/datasources/elasticsearch.md index 28500974644..a92c2660a04 100644 --- a/docs/sources/features/datasources/elasticsearch.md +++ b/docs/sources/features/datasources/elasticsearch.md @@ -172,7 +172,7 @@ Example dashboard: ## Annotations -[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../dashboards/annotations.md" >}}) allow 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. diff --git a/docs/sources/features/datasources/graphite.md b/docs/sources/features/datasources/graphite.md index acf5f56f5c6..93a7e1f7c12 100755 --- a/docs/sources/features/datasources/graphite.md +++ b/docs/sources/features/datasources/graphite.md @@ -162,7 +162,7 @@ Check out the [Advanced Formatting Options section in the Variables]({{< relref ## Annotations -[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../dashboards/annotations.md" >}}) allow 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, diff --git a/docs/sources/features/datasources/influxdb.md b/docs/sources/features/datasources/influxdb.md index 4f876cede8e..9708671343d 100755 --- a/docs/sources/features/datasources/influxdb.md +++ b/docs/sources/features/datasources/influxdb.md @@ -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 "../../dashboards/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: diff --git a/docs/sources/features/datasources/mssql.md b/docs/sources/features/datasources/mssql.md index db3b16e5c8b..5c0e69632bc 100644 --- a/docs/sources/features/datasources/mssql.md +++ b/docs/sources/features/datasources/mssql.md @@ -374,7 +374,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 "../../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. **Columns:** diff --git a/docs/sources/features/datasources/mysql.md b/docs/sources/features/datasources/mysql.md index 20b57218c64..901df69f77a 100755 --- a/docs/sources/features/datasources/mysql.md +++ b/docs/sources/features/datasources/mysql.md @@ -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 "../../dashboards/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:** diff --git a/docs/sources/features/datasources/postgres.md b/docs/sources/features/datasources/postgres.md index 1aaf7ecbc62..142a5d3f70c 100755 --- a/docs/sources/features/datasources/postgres.md +++ b/docs/sources/features/datasources/postgres.md @@ -337,7 +337,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 "../../dashboards/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:** diff --git a/docs/sources/features/datasources/prometheus.md b/docs/sources/features/datasources/prometheus.md index 03fe0fa3e76..6858089e448 100644 --- a/docs/sources/features/datasources/prometheus.md +++ b/docs/sources/features/datasources/prometheus.md @@ -123,7 +123,7 @@ options are enabled, Grafana converts the labels from plain text to a regex comp ## Annotations -[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../dashboards/annotations.md" >}}) allow 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. diff --git a/docs/sources/getting-started/what-is-grafana.md b/docs/sources/getting-started/what-is-grafana.md index 902a61fbde0..0dbe18333c2 100644 --- a/docs/sources/getting-started/what-is-grafana.md +++ b/docs/sources/getting-started/what-is-grafana.md @@ -41,7 +41,7 @@ Annotate graphs with rich events from different data sources. Hover over events This feature, which shows up as a graph marker in Grafana, is useful for correlating data in case something goes wrong. You can create the annotations manually—just control-click on a graph and input some text—or you can fetch data from any data source. -Refer to [Annotations]({{< relref "../reference/annotations.md" >}}) for more information. +Refer to [Annotations]({{< relref "../dashboards/annotations.md" >}}) for more information. ## Dashboard variables diff --git a/docs/sources/guides/whats-new-in-v4-6.md b/docs/sources/guides/whats-new-in-v4-6.md index d713bfa3cb6..85872a5615c 100644 --- a/docs/sources/guides/whats-new-in-v4-6.md +++ b/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 "../dashboards/annotations.md" >}}) documentation is updated to include details on this new exciting feature. ### Cloudwatch diff --git a/docs/sources/guides/whats-new-in-v5-3.md b/docs/sources/guides/whats-new-in-v5-3.md index 4d87f6a40e7..eb7d7a1791e 100644 --- a/docs/sources/guides/whats-new-in-v5-3.md +++ b/docs/sources/guides/whats-new-in-v5-3.md @@ -52,7 +52,7 @@ We've improved the TV and kiosk mode to make it easier to use. There's now an ic 3. Hit the escape key to go back to the default view mode. When switching view modes, the URL will be updated to reflect the view mode selected. This allows a dashboard to be opened with a -certain view mode enabled. Additionally, this also enables [playlists](/reference/playlist) to be started with a certain view mode enabled. +certain view mode enabled. Additionally, this also enables [playlists](/dashboards/playlist) to be started with a certain view mode enabled.
@@ -76,8 +76,8 @@ Learn how to enable and configure it in the [documentation](/auth/gitlab/). ## Annotations -Grafana 5.3 brings improved support for [native annotations](/reference/annotations/#native-annotations) and makes it possible to use template variables when filtering by tags. -Learn more about it in the [documentation](/reference/annotations/#query-by-tag). +Grafana 5.3 brings improved support for [native annotations](/dashboards/annotations/#native-annotations) and makes it possible to use template variables when filtering by tags. +Learn more about it in the [documentation](/dashboards/annotations/#query-by-tag). {{< docs-imagebox img="/img/docs/v53/annotation_tag_filter_variable.png" max-width="600px" >}} diff --git a/docs/sources/menu.yaml b/docs/sources/menu.yaml index 7c630895902..d7239fca3a6 100644 --- a/docs/sources/menu.yaml +++ b/docs/sources/menu.yaml @@ -184,13 +184,13 @@ children: - link: /features/dashboard/dashboards/ name: Overview - - link: /reference/annotations/ + - link: /dashboards/annotations/ name: Annotations - - link: /reference/dashboard_folders/ + - link: /dashboards/dashboard_folders/ name: Folders - - link: /reference/playlist/ + - link: /dashboards/playlist/ name: Playlist - - link: /reference/search/ + - link: /dashboards/search/ name: Search - link: /reference/share_dashboard/ name: Sharing a dashboard @@ -200,7 +200,7 @@ name: Time range controls - link: /reference/export_import/ name: Export and import - - link: /reference/dashboard_history/ + - link: /dashboards/dashboard_history/ name: Dashboard version history - name: Keyboard Shortcuts link: /features/shortcuts/