From cafdbc16448e15548115a9fbbd5bb0661f67c2b2 Mon Sep 17 00:00:00 2001 From: Christopher Moyer <35463610+chri2547@users.noreply.github.com> Date: Tue, 18 Oct 2022 15:07:15 -0500 Subject: [PATCH] restructures directories, corrects relrefs (#57130) --- .../{monitoring.md => monitoring/index.md} | 4 ++-- .../{troubleshooting.md => troubleshooting/index.md} | 0 .../installation/{debian.md => debian/index.md} | 6 +++--- .../installation/{docker.md => docker/index.md} | 8 ++++---- .../installation/{kubernetes.md => kubernetes/index.md} | 0 .../setup-grafana/installation/{mac.md => mac/index.md} | 4 ++-- .../setup-grafana/installation/{rpm.md => rpm/index.md} | 6 +++--- .../installation/{windows.md => windows/index.md} | 8 ++++---- 8 files changed, 18 insertions(+), 18 deletions(-) rename docs/sources/setup-grafana/image-rendering/{monitoring.md => monitoring/index.md} (99%) rename docs/sources/setup-grafana/image-rendering/{troubleshooting.md => troubleshooting/index.md} (100%) rename docs/sources/setup-grafana/installation/{debian.md => debian/index.md} (94%) rename docs/sources/setup-grafana/installation/{docker.md => docker/index.md} (93%) rename docs/sources/setup-grafana/installation/{kubernetes.md => kubernetes/index.md} (100%) rename docs/sources/setup-grafana/installation/{mac.md => mac/index.md} (86%) rename docs/sources/setup-grafana/installation/{rpm.md => rpm/index.md} (96%) rename docs/sources/setup-grafana/installation/{windows.md => windows/index.md} (89%) diff --git a/docs/sources/setup-grafana/image-rendering/monitoring.md b/docs/sources/setup-grafana/image-rendering/monitoring/index.md similarity index 99% rename from docs/sources/setup-grafana/image-rendering/monitoring.md rename to docs/sources/setup-grafana/image-rendering/monitoring/index.md index 29cd61864b3..0348bc02d84 100644 --- a/docs/sources/setup-grafana/image-rendering/monitoring.md +++ b/docs/sources/setup-grafana/image-rendering/monitoring/index.md @@ -9,11 +9,11 @@ keywords: - rendering - plugin - monitoring -title: Monitoring the image renderer +title: Monitor the image renderer weight: 100 --- -# Monitoring the image renderer +# Monitor the image renderer Rendering images requires a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. Monitoring your service can help you allocate the right amount of resources to your rendering service and set the right [rendering mode]({{< relref "./#rendering-mode" >}}). diff --git a/docs/sources/setup-grafana/image-rendering/troubleshooting.md b/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md similarity index 100% rename from docs/sources/setup-grafana/image-rendering/troubleshooting.md rename to docs/sources/setup-grafana/image-rendering/troubleshooting/index.md diff --git a/docs/sources/setup-grafana/installation/debian.md b/docs/sources/setup-grafana/installation/debian/index.md similarity index 94% rename from docs/sources/setup-grafana/installation/debian.md rename to docs/sources/setup-grafana/installation/debian/index.md index aa75de345c6..c0c8ba58b6c 100644 --- a/docs/sources/setup-grafana/installation/debian.md +++ b/docs/sources/setup-grafana/installation/debian/index.md @@ -14,7 +14,7 @@ This page explains how to install Grafana dependencies, download and install Gra ## Note on upgrading -While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. +While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "../../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. > **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid the overhead of installing, maintaining, and scaling your observability stack. The free forever plan includes Grafana, 10K Prometheus series, 50 GB logs, and more.[Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text). @@ -181,8 +181,8 @@ Start Grafana by running: ## Next steps -Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. +Refer to the [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. ## Configure Grafana -Refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Configuration]({{< relref "../../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. diff --git a/docs/sources/setup-grafana/installation/docker.md b/docs/sources/setup-grafana/installation/docker/index.md similarity index 93% rename from docs/sources/setup-grafana/installation/docker.md rename to docs/sources/setup-grafana/installation/docker/index.md index 2560278a452..b8ca45f0975 100644 --- a/docs/sources/setup-grafana/installation/docker.md +++ b/docs/sources/setup-grafana/installation/docker/index.md @@ -151,7 +151,7 @@ Replace `Dockerfile` in above example with `ubuntu.Dockerfile` to build a custom > Only available in Grafana v6.5 and later. This is experimental. -The [Grafana Image Renderer plugin]({{< relref "../image-rendering/#grafana-image-renderer-plugin" >}}) does not currently work if it is installed in a Grafana Docker image. You can build a custom Docker image by using the `GF_INSTALL_IMAGE_RENDERER_PLUGIN` build argument. This installs additional dependencies needed for the Grafana Image Renderer plugin to run. +The [Grafana Image Renderer plugin]({{< relref "../../image-rendering/#grafana-image-renderer-plugin" >}}) does not currently work if it is installed in a Grafana Docker image. You can build a custom Docker image by using the `GF_INSTALL_IMAGE_RENDERER_PLUGIN` build argument. This installs additional dependencies needed for the Grafana Image Renderer plugin to run. Example of how to build and run: @@ -251,12 +251,12 @@ chown -R grafana:grafana /usr/share/grafana ## Next steps -Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. +Refer to the [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. ## Configure Docker image -Refer to [Configure a Grafana Docker image]({{< relref "../configure-docker/" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to [Configure a Grafana Docker image]({{< relref "../../configure-docker/" >}}) page for details on options for customizing your environment, logging, database, and so on. ## Configure Grafana -Refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Configuration]({{< relref "../../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. diff --git a/docs/sources/setup-grafana/installation/kubernetes.md b/docs/sources/setup-grafana/installation/kubernetes/index.md similarity index 100% rename from docs/sources/setup-grafana/installation/kubernetes.md rename to docs/sources/setup-grafana/installation/kubernetes/index.md diff --git a/docs/sources/setup-grafana/installation/mac.md b/docs/sources/setup-grafana/installation/mac/index.md similarity index 86% rename from docs/sources/setup-grafana/installation/mac.md rename to docs/sources/setup-grafana/installation/mac/index.md index 6601459c005..22bba3175e4 100644 --- a/docs/sources/setup-grafana/installation/mac.md +++ b/docs/sources/setup-grafana/installation/mac/index.md @@ -11,7 +11,7 @@ weight: 600 This page explains how to install Grafana and get the service running on your macOS. -**Note on upgrading:** While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Before you perform an upgrade, read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. +**Note on upgrading:** While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Before you perform an upgrade, read [Upgrading Grafana]({{< relref "../../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. ## Install with Homebrew @@ -59,7 +59,7 @@ To install a nightly build, or to install the latest version of Grafana without ## Next steps -Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. Also, refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. Also, refer to the [Configuration]({{< relref "../../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. ## Upgrade diff --git a/docs/sources/setup-grafana/installation/rpm.md b/docs/sources/setup-grafana/installation/rpm/index.md similarity index 96% rename from docs/sources/setup-grafana/installation/rpm.md rename to docs/sources/setup-grafana/installation/rpm/index.md index f0958d6b243..485c8b60dc3 100644 --- a/docs/sources/setup-grafana/installation/rpm.md +++ b/docs/sources/setup-grafana/installation/rpm/index.md @@ -15,7 +15,7 @@ This topic explains how to install Grafana dependencies, download and install Gr ## Note on upgrading -While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. +While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "../../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. > **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid the overhead of installing, maintaining, and scaling your observability stack. The free forever plan includes Grafana, 10K Prometheus series, 50 GB logs, and more.[Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text). @@ -236,8 +236,8 @@ Start Grafana by running: ## Next steps -Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. +Refer to the [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. ## Configure Grafana -Refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Configuration]({{< relref "../../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. diff --git a/docs/sources/setup-grafana/installation/windows.md b/docs/sources/setup-grafana/installation/windows/index.md similarity index 89% rename from docs/sources/setup-grafana/installation/windows.md rename to docs/sources/setup-grafana/installation/windows/index.md index 11bee36e65d..0648f86fc46 100644 --- a/docs/sources/setup-grafana/installation/windows.md +++ b/docs/sources/setup-grafana/installation/windows/index.md @@ -11,7 +11,7 @@ weight: 500 You can either download the Windows installer package or a standalone Windows binary file. -Read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing +Read [Upgrading Grafana]({{< relref "../../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. 1. Navigate to [Download Grafana](https://grafana.com/grafana/download?platform=windows). @@ -30,7 +30,7 @@ You can either use the Windows installer or you can install a standalone Windows 1. Click **Download the installer**. 1. Open and run the installer. -To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}). +To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}). ## Install standalone Windows binary @@ -42,10 +42,10 @@ To run Grafana, open your browser and go to the Grafana port (http://localhost:3 1. Start Grafana by executing `grafana-server.exe`, located in the `bin` directory, preferably from the command line. If you want to run Grafana as a Windows service, then download [NSSM](https://nssm.cc/). It is very easy to add Grafana as a Windows service using that tool. -To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}). +To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}). > **Note:** The default Grafana port is `3000`. This port might require extra permissions on Windows. If it does not appear in the default port, you can try changing to a different port. > > 1. Go into the `conf` directory and copy `sample.ini` to `custom.ini`. **Note:** You should edit `custom.ini`, never `defaults.ini`. > 1. Edit `custom.ini` and uncomment the `http_port` configuration option (`;` is the comment character in ini files) and change it to something like `8080` or similar. That port should not require extra Windows privileges. -> Read more about the [configuration options]({{< relref "../configure-grafana/" >}}). +> Read more about the [configuration options]({{< relref "../../configure-grafana/" >}}).