Docs: updates for file-based menu (#28500)

* initial

* cleanup

* remove bad aliases

* cleanup, fix links

* add docs-file-based-command

* update docs

* update readme

* fix broken links

* fix spelling

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
Robby Milo
2020-11-09 12:26:49 -08:00
committed by GitHub
co-authored by Diana Payton
parent a7e092f243
commit abee02dbcd
271 changed files with 260 additions and 1266 deletions
+1 -4
View File
@@ -1,9 +1,6 @@
+++
title = "Linking"
type = "docs"
[menu.docs]
identifier = "linking"
weight = 100
weight = 120
+++
# Linking overview
+1 -4
View File
@@ -2,9 +2,6 @@
title = "Dashboard links"
description = ""
keywords = ["grafana", "linking", "create links", "link dashboards", "navigate"]
type = "docs"
[menu.docs]
parent = "linking"
weight = 200
+++
@@ -14,7 +11,7 @@ When you create a dashboard link, you can include the time range and current tem
Dashboard links can also be used as shortcuts to external systems, such as submitting [a GitHub issue with the current dashboard name](https://github.com/grafana/grafana/issues/new?title=Dashboard%3A%20HTTP%20Requests).
To see an example of dashboard links in action, check out:
To see an example of dashboard links in action, check out:
- [Dashboard links with variables](https://play.grafana.org/d/rUpVRdamz/dashboard-links-with-variables?orgId=1)
- [Prometheus repeat](https://play.grafana.org/d/000000036/prometheus-repeat?orgId=1)
+1 -2
View File
@@ -2,7 +2,6 @@
title = "URL variables"
keywords = ["grafana", "url variables", "documentation", "variables", "data link"]
aliases = ["/docs/grafana/latest/variables/url-variables.md","/docs/grafana/latest/variables/variable-types/url-variables.md"]
type = "docs"
weight = 400
+++
@@ -50,6 +49,6 @@ Value-specific variables are available under ``__value`` namespace:
When linking to another dashboard that uses template variables, select variable values for whoever clicks the link.
``var-myvar=${myvar}`` - where ``myvar`` is a name of the template variable that matches one in the current dashboard that you want to use.
``var-myvar=${myvar}`` - where ``myvar`` is a name of the template variable that matches one in the current dashboard that you want to use.
If you want to add all of the current dashboard's variables to the URL, then use ``__all_variables``.
+2 -3
View File
@@ -1,7 +1,6 @@
+++
title = "Data links"
keywords = ["grafana", "data links", "documentation", "playlist"]
type = "docs"
aliases = ["/docs/grafana/latest/reference/datalinks/"]
+++
@@ -27,9 +26,9 @@ When creating or updating a data link, press Cmd+Space or Ctrl+Space on your key
1. Expand Data links and then click **Add link**.
1. Enter a **Title**. **Title** is a human-readable label for the link that will be displayed in the UI.
1. Enter the **URL** you want to link to.
You can even add one of the template variables defined in the dashboard. Click in the **URL** field and then type `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. By adding template variables to your panel link, the link sends the user to the right context, with the relevant variables already set. For more information, refer to [Data link variables]({{< relref "data-link-variables.md" >}}).
1. If you want the link to open in a new tab, then select **Open in a new tab**.
1. Click **Save** to save changes and close the window.
1. Click **Save** in the upper right to save your changes to the dashboard.
-4
View File
@@ -1,11 +1,7 @@
+++
title = "Linking overview"
type = "docs"
keywords = ["grafana", "linking", "create links", "link panels", "link dashboards", "navigate"]
[menu.docs]
aliases = ["/docs/grafana/latest/features/navigation-links/"]
identifier = "linking-overview"
parent = "linking"
weight = 100
+++
+4 -7
View File
@@ -2,10 +2,7 @@
title = "Panel links"
description = ""
keywords = ["grafana", "linking", "create links", "link panels", "link dashboards", "navigate"]
type = "docs"
aliases = ["/docs/grafana/latest/features/navigation-links/"]
[menu.docs]
parent = "linking"
weight = 300
+++
@@ -34,14 +31,14 @@ Click the icon on the top left corner of a panel to see available panel links.
## Update a panel link
1. On the Panel tab, find the link that you want to make changes to.
1. Click the Edit (pencil) icon to open the Edit link window.
1. On the Panel tab, find the link that you want to make changes to.
1. Click the Edit (pencil) icon to open the Edit link window.
1. Make any necessary changes.
1. Click **Save** to save changes and close the window.
1. Click **Save** in the upper right to save your changes to the dashboard.
## Delete a panel link
1. On the Panel tab, find the link that you want to delete.
1. Click the **X** icon next to the link you want to delete.
1. On the Panel tab, find the link that you want to delete.
1. Click the **X** icon next to the link you want to delete.
1. Click **Save** in the upper right to save your changes to the dashboard.