Docs: updates for file-based menu (grafana#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 <[email protected]>
jixuan1989 · Nov 9, 2020 · abee02d · abee02d
1 parent a7e092f
commit abee02d
Show file tree

Hide file tree

Showing 271 changed files with 260 additions and 1,266 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,10 +5,10 @@ IMAGE = grafana/grafana-docs-dev:latest
 docs:
 	docker pull $(IMAGE)
 	docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest -p 3002:3002 --rm -it $(IMAGE)
-	
+
 docs-no-pull:
 	docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest -p 3002:3002 --rm -it $(IMAGE)
 
 docs-test:
 	docker pull $(IMAGE)
-	docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest --rm -it $(IMAGE) /bin/bash -c 'make prod'
+	docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest --rm -it $(IMAGE) /bin/bash -c 'make prod'
diff --git a/docs/README.md b/docs/README.md
@@ -24,7 +24,7 @@ Use the Hugo shortcode [relref](https://gohugo.io/content-management/cross-refer
 
 ### Edit the side menu
 
-Edit [sources/menu.yaml](sources/menu.yaml) to make changes to the sidebar. Stop and rerun the `make docs` command for changes to take effect.
+The side menu is automatically build from the file structure. Use the [weight](https://gohugo.io/templates/lists/#by-weight) front matter parameter to order pages.
 
 ### Add images
 

diff --git a/docs/sources/_index.md b/docs/sources/_index.md
@@ -2,7 +2,6 @@
 title = "Grafana documentation"
 description = "Guides, Installation and Feature Documentation"
 keywords = ["grafana", "installation", "documentation"]
-type = "docs"
 aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin", "/docs/grafana/v3.1"]
 +++
 

diff --git a/docs/sources/administration/_index.md b/docs/sources/administration/_index.md
@@ -1,11 +1,7 @@
 +++
 title = "Administration"
 description = "Administration"
-type = "docs"
-[menu.docs]
-name = "Administration"
-identifier = "admin"
-weight = 20
+weight = 40
 +++
 
 # Administration

diff --git a/docs/sources/administration/change-home-dashboard.md b/docs/sources/administration/change-home-dashboard.md
@@ -2,17 +2,12 @@
 title = "Change the default home dashboard"
 description = "How to replace the default home dashboard"
 keywords = ["grafana", "configuration", "documentation", "home"]
-type = "docs"
-[menu.docs]
-name = "Home Dashboard"
-identifier = "change-home-dashboard"
-parent = "admin"
 weight = 100
 +++
 
 # Change the default home dashboard
 
-You can change the default dashboard on the organization, team and user level. The home dashboard you set for the whole organization is the one all users will see by default. The team dashboard applies to all users assigned to the team in Grafana. The team dashboard overrides the organization dashboard settings. Personal dashboard settings override team dashboard settings. 
+You can change the default dashboard on the organization, team and user level. The home dashboard you set for the whole organization is the one all users will see by default. The team dashboard applies to all users assigned to the team in Grafana. The team dashboard overrides the organization dashboard settings. Personal dashboard settings override team dashboard settings.
 
 ## Set the home dashboard for your organization
 
@@ -34,7 +29,7 @@ You can provide your own JSON file to change the home dashboard. No user will be
 1. In the **Export** tab, click on **Save to file**.
 
 #### Use a JSON file as the home dashboard
-1. Save your JSON file somewhere that Grafana can access it, for example, in the Grafana `data` folder of Grafana. 
+1. Save your JSON file somewhere that Grafana can access it, for example, in the Grafana `data` folder of Grafana.
 1. Update your configuration file to set the path to the JSON file. Read how to update this file in the [configuration]({{< relref "./configuration.md">}}) documentation.
 ```ini
 [dashboards]
@@ -45,14 +40,14 @@ default_home_dashboard_path = data/main-dashboard.json
 ## Set home dashboard for your team
 
 1. Navigate to the dashboard you want to set as the home dashboard.
-1. Star this dashboard by clicking on the star next to the dashboard title. 
+1. Star this dashboard by clicking on the star next to the dashboard title.
 1. On the left menu, hover your cursor over the **Configuration** (gear) icon and then click **Teams**.
 1. Click on the team you want to change the home dashboard for and then navigate to the **Settings** tab.
-1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards. 
+1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards.
 
 ## Set your personal home dashboard
 
 1. Navigate to the dashboard you want to set as the home dashboard.
-1. Star this dashboard by clicking on the star next to the dashboard title. 
+1. Star this dashboard by clicking on the star next to the dashboard title.
 1. On the left menu, hover your cursor over your avatar and then click **Preferences**.
-1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards. 
+1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards.
diff --git a/docs/sources/administration/change-your-password.md b/docs/sources/administration/change-your-password.md
@@ -2,10 +2,6 @@
 title = "Change your password"
 description = "How to change your Grafana password"
 keywords = ["grafana", "password", "change", "preferences"]
-type = "docs"
-[menu.docs]
-identifier = "change-your-password"
-parent = "administration"
 weight = 100
 +++
 

diff --git a/docs/sources/administration/cli.md b/docs/sources/administration/cli.md
@@ -2,9 +2,6 @@
 title = "Grafana CLI"
 description = "Guide to using grafana-cli"
 keywords = ["grafana", "cli", "grafana-cli", "command line interface"]
-type = "docs"
-[menu.docs]
-parent = "admin"
 weight = 8
 +++
 

diff --git a/docs/sources/administration/configuration.md b/docs/sources/administration/configuration.md
@@ -2,12 +2,7 @@
 title = "Configuration"
 description = "Configuration documentation"
 keywords = ["grafana", "configuration", "documentation"]
-type = "docs"
 aliases = ["/docs/grafana/latest/installation/configuration/"]
-[menu.docs]
-name = "Configuration"
-identifier = "config"
-parent = "admin"
 weight = 300
 +++
 

diff --git a/docs/sources/administration/configure-docker.md b/docs/sources/administration/configure-docker.md
@@ -2,12 +2,7 @@
 title = "Configure Grafana Docker image"
 description = "Guide for configuring the Grafana Docker image"
 keywords = ["grafana", "configuration", "documentation", "docker"]
-type = "docs"
 aliases = ["/docs/grafana/latest/installation/configure-docker/"]
-[menu.docs]
-name = "Configure Grafana Docker image"
-identifier = "configure-docker"
-parent = "administration"
 weight = 400
 +++
 

diff --git a/docs/sources/administration/image_rendering.md b/docs/sources/administration/image_rendering.md
@@ -2,9 +2,6 @@
 title = "Image rendering"
 description = ""
 keywords = ["grafana", "image", "rendering", "plugin"]
-type = "docs"
-[menu.docs]
-parent = "features"
 weight = 8
 +++
 

diff --git a/docs/sources/administration/jaeger-instrumentation.md b/docs/sources/administration/jaeger-instrumentation.md
@@ -2,9 +2,6 @@
 title = "Jaeger instrumentation"
 description = "Jaeger traces emitted and propagation by Grafana"
 keywords = ["grafana", "jaeger", "tracing"]
-type = "docs"
-[menu.docs]
-parent = "admin"
 weight = 9
 +++
 

diff --git a/docs/sources/administration/metrics.md b/docs/sources/administration/metrics.md
@@ -2,9 +2,6 @@
 title = "Internal Grafana metrics"
 description = "Internal metrics exposed by Grafana"
 keywords = ["grafana", "metrics", "internal metrics"]
-type = "docs"
-[menu.docs]
-parent = "admin"
 weight = 8
 +++
 
@@ -29,7 +26,7 @@ When enabled, Grafana exposes a number of metrics, including:
 
 These instructions assume you have already added Prometheus as a data source in Grafana.
 
-1. Enable Prometheus to scrape metrics from Grafana. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: 
+1. Enable Prometheus to scrape metrics from Grafana. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options:
 
    ```
    # Metrics available at HTTP API Url /metrics
@@ -57,7 +54,7 @@ These instructions assume you have already added Prometheus as a data source in
 
       scrape_interval: 15s
       scrape_timeout: 5s
-  
+
       static_configs:
         - targets: ['localhost:3000']
    ```
@@ -70,7 +67,7 @@ These instructions assume you have already added Prometheus as a data source in
 
 These instructions assume you have already added Graphite as a data source in Grafana.
 
-1. Enable sending metrics to Graphite. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: 
+1. Enable sending metrics to Graphite. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options:
 
    ```
    # Metrics available at HTTP API Url /metrics

diff --git a/docs/sources/administration/preferences.md b/docs/sources/administration/preferences.md
@@ -2,10 +2,6 @@
 title = "Change your preferences"
 description = "How to change your Grafana preferences"
 keywords = ["grafana", "profile", "change", "preferences"]
-type = "docs"
-[menu.docs]
-identifier = "preferences"
-parent = "administration"
 weight = 200
 +++
 

diff --git a/docs/sources/administration/provisioning.md b/docs/sources/administration/provisioning.md
@@ -2,10 +2,7 @@
 title = "Provisioning"
 description = ""
 keywords = ["grafana", "provisioning"]
-type = "docs"
 aliases = ["/docs/grafana/latest/installation/provisioning"]
-[menu.docs]
-parent = "admin"
 weight = 8
 +++
 

diff --git a/docs/sources/administration/security.md b/docs/sources/administration/security.md
@@ -2,12 +2,7 @@
 title = "Security"
 description = "Security Docs"
 keywords = ["grafana", "security", "documentation"]
-type = "docs"
 aliases = ["/docs/grafana/latest/installation/security/"]
-[menu.docs]
-name = "Security"
-identifier = "security"
-parent = "admin"
 weight = 500
 +++
 
@@ -23,7 +18,7 @@ You can configure Grafana to only allow certain IP addresses or hostnames to be
 
 ## Firewall rules
 
-Configure a firewall to restrict Grafana from making network requests to sensitive internal web services. 
+Configure a firewall to restrict Grafana from making network requests to sensitive internal web services.
 
 There are many firewall tools available, refer to the documentation for your specific security tool. For example, Linux users can use [iptables](https://en.wikipedia.org/wiki/Iptables).
 

diff --git a/docs/sources/administration/set-up-for-high-availability.md b/docs/sources/administration/set-up-for-high-availability.md
@@ -1,9 +1,7 @@
 +++
 title = "Set up Grafana for high availability"
-type = "docs"
 keywords = ["grafana", "tutorials", "HA", "high availability"]
 aliases = ["/docs/grafana/latest/tutorials/ha_setup/"]
-[menu.docs]
 weight = 1200
 +++
 

diff --git a/docs/sources/administration/view-server-settings.md b/docs/sources/administration/view-server-settings.md
@@ -2,11 +2,6 @@
 title = "View server settings"
 description = "How to view server settings in the Grafana UI"
 keywords = ["grafana", "configuration", "server", "settings"]
-type = "docs"
-[menu.docs]
-name = "Configuration"
-identifier = "config"
-parent = "admin"
 weight = 350
 +++
 

diff --git a/docs/sources/administration/view-server-stats.md b/docs/sources/administration/view-server-stats.md
@@ -1,8 +1,6 @@
 +++
 title = "View server stats"
-type = "docs"
 keywords = ["grafana", "server", "statistics"]
-[menu.docs]
 weight = 1150
 +++
 

diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md
@@ -1,9 +1,5 @@
 +++
 title = "Alerting"
-type = "docs"
-[menu.docs]
-identifier = "alerting"
-parent = "features"
 weight = 100
 +++
 

diff --git a/docs/sources/alerting/alerts-overview.md b/docs/sources/alerting/alerts-overview.md
@@ -1,10 +1,6 @@
 +++
 title = "Alerts overview"
-type = "docs"
-[menu.docs]
-identifier = "alerting"
-parent = "Alerting"
-aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/rules/#query-condition-example", "/docs/grafana/latest/alerting/rules/#for", "/docs/grafana/latest/alerting/rules/#rule-config"]
+aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/"]
 weight = 100
 +++
 

diff --git a/docs/sources/alerting/create-alerts.md b/docs/sources/alerting/create-alerts.md
@@ -2,11 +2,6 @@
 title = "Create alerts"
 description = "Configure alert rules"
 keywords = ["grafana", "alerting", "guide", "rules"]
-type = "docs"
-[menu.docs]
-name = "Create alerts"
-identifier = "create-alerts"
-parent = "alerting"
 weight = 200
 +++
 

diff --git a/docs/sources/alerting/notifications.md b/docs/sources/alerting/notifications.md
@@ -2,11 +2,6 @@
 title = "Alert notifications"
 description = "Alerting notifications guide"
 keywords = ["Grafana", "alerting", "guide", "notifications"]
-type = "docs"
-[menu.docs]
-name = "Notifications"
-identifier = "alert-notification"
-parent = "alerting"
 weight = 100
 +++
 

diff --git a/docs/sources/alerting/pause-an-alert-rule.md b/docs/sources/alerting/pause-an-alert-rule.md
@@ -2,10 +2,6 @@
 title = "Pause alert rule"
 description = "Pause an existing alert rule"
 keywords = ["grafana", "alerting", "guide", "rules", "view"]
-type = "docs"
-[menu.docs]
-identifier = "pause-alerts"
-parent = "alerting"
 weight = 400
 +++
 

diff --git a/docs/sources/alerting/troubleshoot-alerts.md b/docs/sources/alerting/troubleshoot-alerts.md
@@ -2,11 +2,6 @@
 title = "Troubleshoot alerts"
 description = "Troubleshoot alert rules"
 keywords = ["grafana", "alerting", "guide", "rules", "troubleshoot"]
-type = "docs"
-[menu.docs]
-name = "Troubleshoot alerts"
-identifier = "troubleshoot-alerts"
-parent = "alerting"
 weight = 500
 +++
 

diff --git a/docs/sources/alerting/view-alerts.md b/docs/sources/alerting/view-alerts.md
@@ -2,11 +2,6 @@
 title = "View alerts"
 description = "View existing alert rules"
 keywords = ["grafana", "alerting", "guide", "rules", "view"]
-type = "docs"
-[menu.docs]
-name = "View alerts"
-identifier = "view-alerts"
-parent = "alerting"
 weight = 400
 +++
 

diff --git a/docs/sources/auth/_index.md b/docs/sources/auth/_index.md
@@ -1,11 +1,6 @@
 +++
 title = "Authentication"
 description = "Authentication"
-type = "docs"
-[menu.docs]
-name = "Authentication"
-identifier = "authentication"
-parent = "admin"
 weight = 30
 +++
 
@@ -18,13 +13,13 @@ Here is a table showing all supported authentication providers and the features
 See also, [Grafana Authentication]({{< relref "grafana.md" >}}).
 
 Provider | Support | Role mapping | Team sync<br> *(Enterprise only)* | Active sync<br> *(Enterprise only)*
--------- | :-----: | :----------: | :-------: | :---------: 
-[Auth Proxy]({{< relref "auth-proxy.md" >}})       | v2.1+ | - | v6.3+ | - 
-[Azure AD OAuth]({{< relref "azuread.md" >}})      | v6.7+ | v6.7+ | v6.7+ | - 
-[Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - 
+-------- | :-----: | :----------: | :-------: | :---------:
+[Auth Proxy]({{< relref "auth-proxy.md" >}})       | v2.1+ | - | v6.3+ | -
+[Azure AD OAuth]({{< relref "azuread.md" >}})      | v6.7+ | v6.7+ | v6.7+ | -
+[Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | -
 [GitHub OAuth]({{< relref "github.md" >}})         | v2.0+ | - | v6.3+ | -
 [GitLab OAuth]({{< relref "gitlab.md" >}})         | v5.3+ | - | v6.4+ | -
-[Google OAuth]({{< relref "google.md" >}})         | v2.0+ | - | - | - 
+[Google OAuth]({{< relref "google.md" >}})         | v2.0+ | - | - | -
 [LDAP]({{< relref "ldap.md" >}})                   | v2.1+ | v2.1+ | v5.3+ | v6.3+
-[Okta OAuth]({{< relref "okta.md" >}})             | v7.0+ | v7.0+ | v7.0+ | - 
-[SAML]({{< relref "../enterprise/saml.md" >}}) (Enterprise only)    | v6.3+ | v7.0+ | v7.0+ | - 
+[Okta OAuth]({{< relref "okta.md" >}})             | v7.0+ | v7.0+ | v7.0+ | -
+[SAML]({{< relref "../enterprise/saml.md" >}}) (Enterprise only)    | v6.3+ | v7.0+ | v7.0+ | -
diff --git a/docs/sources/auth/auth-proxy.md b/docs/sources/auth/auth-proxy.md
@@ -2,12 +2,7 @@
 title = "Auth Proxy"
 description = "Grafana Auth Proxy Guide "
 keywords = ["grafana", "configuration", "documentation", "proxy"]
-type = "docs"
 aliases = ["/docs/grafana/latest/tutorials/authproxy/"]
-[menu.docs]
-name = "Auth Proxy"
-identifier = "auth-proxy"
-parent = "authentication"
 weight = 200
 +++