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
co-authored by
Diana Payton
Diana Payton
parent
a7e092f243
commit
abee02dbcd
@@ -2,11 +2,7 @@
|
||||
title = "Installation"
|
||||
description = "Installation guide for Grafana"
|
||||
keywords = ["grafana", "installation", "documentation"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/installation/installation/", "/docs/grafana/v2.1/installation/install/", "/docs/grafana/latest/install"]
|
||||
[menu.docs]
|
||||
name = "Installation"
|
||||
identifier = "installation"
|
||||
weight = 30
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
title = "Install on Debian/Ubuntu"
|
||||
description = "Install guide for Grafana on Debian or Ubuntu"
|
||||
keywords = ["grafana", "installation", "documentation"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/installation/installation/debian"]
|
||||
[menu.docs]
|
||||
identifier = "debian"
|
||||
parent = "installation"
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
@@ -22,7 +18,7 @@ You can install Grafana using our official APT repository, by downloading a `.de
|
||||
|
||||
### Install from APT repository
|
||||
|
||||
If you install from the APT repository, then Grafana is automatically updated every time you run `apt-get update`.
|
||||
If you install from the APT repository, then Grafana is automatically updated every time you run `apt-get update`.
|
||||
|
||||
| Grafana Version | Package | Repository |
|
||||
|-----------------|---------|------------|
|
||||
@@ -44,12 +40,12 @@ wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add -
|
||||
Add this repository for stable releases:
|
||||
|
||||
```bash
|
||||
echo "deb https://packages.grafana.com/enterprise/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
echo "deb https://packages.grafana.com/enterprise/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
```
|
||||
|
||||
Add this repository if you want beta releases:
|
||||
```bash
|
||||
echo "deb https://packages.grafana.com/enterprise/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
echo "deb https://packages.grafana.com/enterprise/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
```
|
||||
|
||||
After you add the repository:
|
||||
@@ -70,12 +66,12 @@ wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add -
|
||||
Add this repository for stable releases:
|
||||
|
||||
```bash
|
||||
echo "deb https://packages.grafana.com/oss/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
echo "deb https://packages.grafana.com/oss/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
```
|
||||
|
||||
Add this repository if you want beta releases:
|
||||
```bash
|
||||
echo "deb https://packages.grafana.com/oss/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
echo "deb https://packages.grafana.com/oss/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
|
||||
```
|
||||
|
||||
After you add the repository:
|
||||
@@ -89,7 +85,7 @@ sudo apt-get install grafana
|
||||
|
||||
If you install the `.deb` package, then you will need to manually update Grafana for each new version.
|
||||
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
* The most recent Grafana version is selected by default.
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
@@ -154,7 +150,7 @@ sudo update-rc.d grafana-server defaults
|
||||
|
||||
The `grafana-server` binary .tar.gz needs the working directory to be the root install directory where the binary and the `public` folder are located.
|
||||
|
||||
Start Grafana by running:
|
||||
Start Grafana by running:
|
||||
```bash
|
||||
./bin/grafana-server web
|
||||
```
|
||||
|
||||
@@ -2,11 +2,6 @@
|
||||
title = "Run Grafana Docker image"
|
||||
description = "Guide for running Grafana using Docker"
|
||||
keywords = ["grafana", "configuration", "documentation", "docker"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Run Grafana Docker image"
|
||||
identifier = "docker"
|
||||
parent = "installation"
|
||||
weight = 600
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,9 +2,6 @@
|
||||
title = "Install on macOS"
|
||||
description = "Installing Grafana on macOS"
|
||||
keywords = ["grafana", "configuration", "documentation", "mac", "homebrew", "osx"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
parent = "installation"
|
||||
weight = 500
|
||||
+++
|
||||
|
||||
@@ -18,7 +15,7 @@ This page explains how to install Grafana and get the service running on your ma
|
||||
|
||||
Use [Homebrew](http://brew.sh/) to install the most recent released version of Grafana using Homebrew package.
|
||||
|
||||
1. On the Homberew homepage, search for Grafana. The last stable and released version is listed.
|
||||
1. On the Homberew homepage, search for Grafana. The last stable and released version is listed.
|
||||
1. Open a terminal and enter:
|
||||
```
|
||||
brew update
|
||||
|
||||
@@ -2,11 +2,6 @@
|
||||
title = "Requirements"
|
||||
description = "Requirements for Grafana"
|
||||
keywords = ["grafana", "installation", "documentation"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Requirements"
|
||||
identifier = "requirements"
|
||||
parent = "installation"
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
@@ -29,7 +24,7 @@ Installation of Grafana on other operating systems is possible, but it is neithe
|
||||
|
||||
## Hardware recommendations
|
||||
|
||||
Grafana does not use a lot of resources and is very lightweight in use of memory and CPU.
|
||||
Grafana does not use a lot of resources and is very lightweight in use of memory and CPU.
|
||||
|
||||
Minimum recommended memory: 255 MB
|
||||
Minimum recommended CPU: 1
|
||||
|
||||
@@ -3,11 +3,6 @@ title = "Install on RPM-based Linux"
|
||||
description = "Grafana Installation guide for RPM-based Linux, such as Centos, Fedora, OpenSuse, and Red Hat."
|
||||
keywords = ["grafana", "installation", "documentation", "centos", "fedora", "opensuse", "redhat"]
|
||||
aliases = ["/docs/grafana/latest/installation/installation/rpm"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Install on RPM-based Linux"
|
||||
identifier = "rpm"
|
||||
parent = "installation"
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
@@ -84,7 +79,7 @@ sudo yum install grafana-enterprise
|
||||
|
||||
If you install manually with YUM, then you will need to manually update Grafana for each new version. To enable automatic updates for your Grafana installation please use the instructions below to install via our YUM repository.
|
||||
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
@@ -109,7 +104,7 @@ If you install with RPM, then you will need to manually update Grafana for each
|
||||
|
||||
**Note:** The .rpm files are signed, you can verify the signature with this [public GPG key](https://packages.grafana.com/gpg.key).
|
||||
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
@@ -185,7 +180,7 @@ sudo /sbin/chkconfig --add grafana-server
|
||||
|
||||
The `grafana-server` binary needs the working directory to be the root install directory where the binary and the `public` folder are located.
|
||||
|
||||
Start Grafana by running:
|
||||
Start Grafana by running:
|
||||
```bash
|
||||
./bin/grafana-server web
|
||||
```
|
||||
|
||||
@@ -2,11 +2,6 @@
|
||||
title = "Upgrade Grafana"
|
||||
description = "Guide for upgrading Grafana"
|
||||
keywords = ["grafana", "configuration", "documentation", "upgrade"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Upgrade Grafana"
|
||||
identifier = "upgrading"
|
||||
parent = "installation"
|
||||
weight = 700
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,9 +2,6 @@
|
||||
title = "Install on Windows"
|
||||
description = "Install Grafana on Windows"
|
||||
keywords = ["grafana", "configuration", "documentation", "windows"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
parent = "installation"
|
||||
weight = 400
|
||||
+++
|
||||
|
||||
@@ -16,7 +13,7 @@ Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on
|
||||
installation.
|
||||
|
||||
1. Navigate to [Download Grafana](https://grafana.com/grafana/download?platform=windows).
|
||||
1. Select a Grafana version you want to install.
|
||||
1. Select a Grafana version you want to install.
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
@@ -29,7 +26,7 @@ You can either use the Windows installer or you can install a standalone Windows
|
||||
## Install with Windows installer (recommended)
|
||||
|
||||
1. Click **Download the installer**.
|
||||
1. Open and run 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/getting-started/" >}}).
|
||||
|
||||
@@ -38,7 +35,7 @@ To run Grafana, open your browser and go to the Grafana port (http://localhost:3
|
||||
1. Click **Download the zip file**.
|
||||
**Important:** After you've downloaded the zip file and before extracting it, make sure to open the properties for that file (right-click **Properties**) and select the `unblock` check box and then click `Ok`.
|
||||
|
||||
1. Extract this folder to anywhere you want Grafana to run from.
|
||||
1. Extract this folder to anywhere you want Grafana to run from.
|
||||
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user