diff --git a/.github/workflows/documentation-ci.yml b/.github/workflows/documentation-ci.yml index 80ad62a573e..061aad71099 100644 --- a/.github/workflows/documentation-ci.yml +++ b/.github/workflows/documentation-ci.yml @@ -12,8 +12,7 @@ jobs: - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: persist-credentials: false - - uses: grafana/writers-toolkit/vale-action@4b1248585248751e3b12fd020cf7ac91540ca09c # vale-action/v1.0.0 + - uses: grafana/writers-toolkit/vale-action@13205961f20ad13843505a9b84fdf032f911a3f4 # vale-action/v1.1.0 with: - filter: | - '.Name in ["Grafana.WordList", "Grafana.Spelling", "Grafana.ProductPossessives"]' + filter: '.Name in ["Grafana.WordList", "Grafana.Spelling", "Grafana.ProductPossessives"]' token: ${{ secrets.GITHUB_TOKEN }} diff --git a/docs/sources/cli.md b/docs/sources/cli.md index 3352c8e85ba..3a0df07cbd2 100644 --- a/docs/sources/cli.md +++ b/docs/sources/cli.md @@ -17,7 +17,9 @@ weight: 400 # Grafana CLI -Grafana CLI is a small executable that is bundled with Grafana server. It can be executed on the same machine Grafana server is running on. Grafana CLI has `plugins` and `admin` commands, as well as global options. +Grafana 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 CLI has `plugins` and `admin` commands, as well as global options. To list all commands and options: @@ -25,13 +27,17 @@ To list all commands and options: grafana cli -h ``` -## Invoking Grafana CLI +## Run Grafana CLI -To invoke Grafana CLI, add the path to the grafana binaries in your `PATH` environment variable. Alternately, if your current directory is the `bin` directory, use `./grafana cli`. Otherwise, you can specify full path to the CLI. For example, on Linux `/usr/share/grafana/bin/grafana` and on Windows `C:\Program Files\GrafanaLabs\grafana\bin\grafana.exe`, and invoke it with `grafana cli`. +To run Grafana 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`. -{{% admonition type="note" %}} -Some commands, such as installing or removing plugins, require `sudo` on Linux. If you are on Windows, run Windows PowerShell as Administrator. -{{% /admonition %}} +{{< 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 >}} ## Grafana CLI command syntax