From 0f6741ff2959fe1e18b933dbf2500f490b779484 Mon Sep 17 00:00:00 2001 From: "grafana-delivery-bot[bot]" <132647405+grafana-delivery-bot[bot]@users.noreply.github.com> Date: Tue, 28 Oct 2025 13:24:16 +0100 Subject: [PATCH] [release-12.2.2] Docs: Admin tweaks - Edits, weights (#113089) Co-authored-by: Anna Urbiztondo --- .../announcement-banner/_index.md | 1 + .../administration/back-up-grafana/index.md | 2 +- docs/sources/administration/cli.md | 37 ++++++++++--------- .../administration/correlations/_index.md | 2 +- .../data-source-management/_index.md | 2 +- .../enterprise-licensing/_index.md | 2 +- .../administration/grafana-advisor/_index.md | 2 +- .../administration/migration-guide/_index.md | 1 + .../organization-management/index.md | 2 +- .../organization-preferences/index.md | 2 +- .../administration/provisioning/index.md | 3 +- .../administration/recorded-queries/index.md | 7 ++-- .../roles-and-permissions/_index.md | 2 +- docs/sources/administration/search/_index.md | 1 + .../administration/service-accounts/_index.md | 2 +- .../administration/stats-and-license/index.md | 3 +- .../administration/team-management/_index.md | 6 +-- .../administration/user-management/_index.md | 4 +- 18 files changed, 45 insertions(+), 36 deletions(-) diff --git a/docs/sources/administration/announcement-banner/_index.md b/docs/sources/administration/announcement-banner/_index.md index b67e0d7ca1d..020ca45c877 100644 --- a/docs/sources/administration/announcement-banner/_index.md +++ b/docs/sources/administration/announcement-banner/_index.md @@ -9,6 +9,7 @@ labels: menuTitle: Announcement banner title: Create and configure announcement banner description: How to create an announcement banner to show important updates and information at the top of every Grafana page. +weight: 5500 --- # Create an announcement banner diff --git a/docs/sources/administration/back-up-grafana/index.md b/docs/sources/administration/back-up-grafana/index.md index 2c9286f0b0e..0ceb0b4e5fc 100644 --- a/docs/sources/administration/back-up-grafana/index.md +++ b/docs/sources/administration/back-up-grafana/index.md @@ -8,7 +8,7 @@ labels: - enterprise - oss title: Back up Grafana -weight: 80 +weight: 100 menuTitle: Back up Grafana --- diff --git a/docs/sources/administration/cli.md b/docs/sources/administration/cli.md index 0e8e6e611e0..416b1c24335 100644 --- a/docs/sources/administration/cli.md +++ b/docs/sources/administration/cli.md @@ -1,45 +1,43 @@ --- aliases: - ../cli/ # /docs/grafana/latest/cli/ -description: Guide to using grafana server cli +description: Guide to using the Grafana server CLI keywords: - grafana - cli - grafana cli - command line interface + - admin labels: products: - enterprise - oss title: Grafana server CLI -weight: 1100 +menuTitle: Admin with Grafana server CLI +weight: 4000 --- -# Grafana server CLI +# Administer Grafana with the Grafana server CLI -Grafana server CLI is a small executable that's bundled with Grafana server. -You can run it on the same machine Grafana server is running on. -Grafana server CLI has `plugins` and `admin` commands, as well as global options. +You can administer your Grafana instance with the Grafana server CLI, a small executable bundled with Grafana server. -To list all commands and options: +The Grafana server CLI has `plugins` and `admin` commands, as well as global options. To list them, run: ``` grafana cli -h ``` -## Run Grafana server CLI +For more details read on. -To run Grafana server CLI, add the path to the Grafana binaries in your `PATH` environment variable. -Alternately, if your current directory is the `bin` directory, run `./grafana cli`. -Otherwise, you can specify full path to the binary. -For example, on Linux `/usr/share/grafana/bin/grafana` and on Windows `C:\Program Files\GrafanaLabs\grafana\bin\grafana.exe`, and run it with `grafana cli`. +## Run the Grafana server CLI -{{< admonition type="note" >}} -Some commands, such as installing or removing plugins, require `sudo` on Linux. -If you're on Windows, run Windows PowerShell as Administrator. -{{< /admonition >}} +You can run the Grafana server CLI on the same machine Grafana server is running on. -## Grafana CLI command syntax +To run the CLI you have the following options: + +- Add the path to the Grafana binaries in your `PATH` environment variable. +- If your current directory is the `bin` directory, run `./grafana cli`. +- Otherwise, you can specify full path to the binary. For example, `/usr/share/grafana/bin/grafana` on Linux and `C:\Program Files\GrafanaLabs\grafana\bin\grafana.exe` on Windows. The general syntax for commands in Grafana server CLI is: @@ -47,6 +45,11 @@ The general syntax for commands in Grafana server CLI is: grafana cli [global options] command [command options] [arguments...] ``` +{{< admonition type="note" >}} +Some commands, such as installing or removing plugins, require `sudo` on Linux. +If you're on Windows, run Windows PowerShell as Administrator. +{{< /admonition >}} + ## Global options Grafana server CLI allows you to temporarily override certain Grafana default settings. Except for `--help` and `--version`, most global options are only used by developers. diff --git a/docs/sources/administration/correlations/_index.md b/docs/sources/administration/correlations/_index.md index 36e0badf5f5..7d449ce88b9 100644 --- a/docs/sources/administration/correlations/_index.md +++ b/docs/sources/administration/correlations/_index.md @@ -7,7 +7,7 @@ labels: - enterprise - oss title: Correlations -weight: 900 +weight: 6000 --- # Correlations diff --git a/docs/sources/administration/data-source-management/_index.md b/docs/sources/administration/data-source-management/_index.md index 1a28b0001c3..8cb0d57d30e 100644 --- a/docs/sources/administration/data-source-management/_index.md +++ b/docs/sources/administration/data-source-management/_index.md @@ -12,7 +12,7 @@ labels: - enterprise - cloud title: Data source management -weight: 100 +weight: 500 --- # Data source management diff --git a/docs/sources/administration/enterprise-licensing/_index.md b/docs/sources/administration/enterprise-licensing/_index.md index 11619aa43e7..759431ebad7 100644 --- a/docs/sources/administration/enterprise-licensing/_index.md +++ b/docs/sources/administration/enterprise-licensing/_index.md @@ -18,7 +18,7 @@ labels: - enterprise - oss title: Grafana Enterprise license -weight: 500 +weight: 5500 --- # Grafana Enterprise license diff --git a/docs/sources/administration/grafana-advisor/_index.md b/docs/sources/administration/grafana-advisor/_index.md index 38673e9e121..6292a13fd6b 100644 --- a/docs/sources/administration/grafana-advisor/_index.md +++ b/docs/sources/administration/grafana-advisor/_index.md @@ -1,7 +1,7 @@ --- title: Grafana Advisor description: Learn more about Grafana Advisor, the app to monitor the health of your Grafana instance -weight: 300 +weight: 700 labels: products: - oss diff --git a/docs/sources/administration/migration-guide/_index.md b/docs/sources/administration/migration-guide/_index.md index 94576db65c0..d601b95d331 100644 --- a/docs/sources/administration/migration-guide/_index.md +++ b/docs/sources/administration/migration-guide/_index.md @@ -9,6 +9,7 @@ keywords: - Grafana OSS menuTitle: Migrate from Grafana OSS/Enterprise to Grafana Cloud title: Migrate from Grafana OSS/Enterprise to Grafana Cloud +weight: 7000 --- # Migrate from Grafana OSS/Enterprise to Grafana Cloud diff --git a/docs/sources/administration/organization-management/index.md b/docs/sources/administration/organization-management/index.md index 7eef5d45424..621374d4884 100644 --- a/docs/sources/administration/organization-management/index.md +++ b/docs/sources/administration/organization-management/index.md @@ -14,7 +14,7 @@ labels: - oss menuTitle: Manage organizations title: Manage organizations -weight: 200 +weight: 3500 --- # Manage organizations diff --git a/docs/sources/administration/organization-preferences/index.md b/docs/sources/administration/organization-preferences/index.md index bc54894a3ab..0df51d324c7 100644 --- a/docs/sources/administration/organization-preferences/index.md +++ b/docs/sources/administration/organization-preferences/index.md @@ -11,7 +11,7 @@ labels: - enterprise - oss title: Organization preferences -weight: 500 +weight: 3600 --- # Organization preferences diff --git a/docs/sources/administration/provisioning/index.md b/docs/sources/administration/provisioning/index.md index 8874448224f..51fd1f4c604 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -11,7 +11,8 @@ labels: - enterprise - oss title: Provision Grafana -weight: 600 +menuTitle: Provision Grafana +weight: 4100 --- # Provision Grafana diff --git a/docs/sources/administration/recorded-queries/index.md b/docs/sources/administration/recorded-queries/index.md index 425ff2bbf7c..e76021ae8d7 100644 --- a/docs/sources/administration/recorded-queries/index.md +++ b/docs/sources/administration/recorded-queries/index.md @@ -11,11 +11,12 @@ labels: products: - cloud - enterprise -title: Recorded queries -weight: 300 +title: Recorded queries (deprecated) +menuTitle: Recorded queries (deprecated) +weight: 9000 --- -# DEPRECATED Recorded queries +# Recorded queries (deprecated) {{< admonition type="warning" >}} Recorded queries are deprecated. Please use the new [Grafana-managed recording rules](/docs/grafana/latest/alerting/alerting-rules/create-recording-rules/create-grafana-managed-recording-rules) instead. diff --git a/docs/sources/administration/roles-and-permissions/_index.md b/docs/sources/administration/roles-and-permissions/_index.md index eb2850eab15..ab1f97eca5a 100644 --- a/docs/sources/administration/roles-and-permissions/_index.md +++ b/docs/sources/administration/roles-and-permissions/_index.md @@ -12,7 +12,7 @@ labels: - oss - cloud title: Roles and permissions -weight: 300 +weight: 3100 --- # Roles and permissions diff --git a/docs/sources/administration/search/_index.md b/docs/sources/administration/search/_index.md index 5bd777e9f01..7e41f995ad3 100644 --- a/docs/sources/administration/search/_index.md +++ b/docs/sources/administration/search/_index.md @@ -15,6 +15,7 @@ labels: - oss menutitle: Search title: Search +weight: 8000 --- # Grafana search diff --git a/docs/sources/administration/service-accounts/_index.md b/docs/sources/administration/service-accounts/_index.md index 5eb48e324b6..34bbd916610 100644 --- a/docs/sources/administration/service-accounts/_index.md +++ b/docs/sources/administration/service-accounts/_index.md @@ -15,7 +15,7 @@ labels: - cloud menuTitle: Service accounts title: Service accounts -weight: 800 +weight: 4200 refs: service-accounts: - pattern: /docs/grafana/ diff --git a/docs/sources/administration/stats-and-license/index.md b/docs/sources/administration/stats-and-license/index.md index ec926f73c2f..c8fe61fe47d 100644 --- a/docs/sources/administration/stats-and-license/index.md +++ b/docs/sources/administration/stats-and-license/index.md @@ -16,7 +16,8 @@ labels: - cloud - enterprise title: View server statistics and license -weight: 400 +menutitle: Server stats and license +weight: 5000 --- # View server statistics and license diff --git a/docs/sources/administration/team-management/_index.md b/docs/sources/administration/team-management/_index.md index 0a35b764cb7..5fff00428f3 100644 --- a/docs/sources/administration/team-management/_index.md +++ b/docs/sources/administration/team-management/_index.md @@ -15,11 +15,11 @@ keywords: - microservices - architecture menuTitle: Grafana Teams -title: Grafana Teams -weight: 100 +title: Manage teams with Grafana Teams +weight: 2000 --- -# Grafana Teams +# Manage teams with Grafana Teams Grafana Teams makes it easy to organize and administer groups of users in your enterprise. Teams allows you to grant permissions to a group of users instead of granting permissions to individual users one at a time. diff --git a/docs/sources/administration/user-management/_index.md b/docs/sources/administration/user-management/_index.md index ad3be03f7cb..3b6ff208903 100644 --- a/docs/sources/administration/user-management/_index.md +++ b/docs/sources/administration/user-management/_index.md @@ -5,8 +5,8 @@ labels: products: - enterprise - oss -title: User management -weight: 200 +title: Manage users +weight: 3000 --- # User management