Docs: removing docs debt in install docs (#101750)

* Docs: removing docs debt in install docs * cleaning up set up docs debt * fixing some vale errors * fixing broken admonition shortcode * fixing broken shortcode * fixing broken shortcode * working to the grafana authentication config * updating some more files * editing down to ldap in the repo * editing ldap doc except final section with link needed * Finishing doc debt cleanup through configure authetication * fixing shortcodes reverted by merge conflict fix * fixing admonition * fixing more broken shortcodes * adjusting some wordings ot make vale happy * updating feature toggle info
2025-04-09 09:02:51 -05:00
parent af6c536c22
commit 8dfb0874a0
24 changed files with 243 additions and 236 deletions
@@ -37,9 +37,9 @@ Grafana supports the following operating systems:
 - [macOS](mac/)
 - [Windows](windows/)

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 Installation of Grafana on other operating systems is possible, but is not recommended or supported.
-{{% /admonition %}}
+{{< /admonition >}}

 ## Hardware recommendations

@@ -66,20 +66,20 @@ Grafana supports the following databases:

 By default Grafana uses an embedded SQLite database, which is stored in the Grafana installation location.

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 SQLite works well if your environment is small, but is not recommended when your environment starts growing. For more information about the limitations of SQLite, refer to [Appropriate Uses For SQLite](https://www.sqlite.org/whentouse.html). If you want [high availability](/docs/grafana/latest/setup-grafana/set-up-for-high-availability), you must use either a MySQL or PostgreSQL database. For information about how to define the database configuration parameters inside the `grafana.ini` file, refer to [[database]](/docs/grafana/latest/setup-grafana/configure-grafana/#database).
-{{% /admonition %}}
+{{< /admonition >}}

 Grafana supports the versions of these databases that are officially supported by the project at the time a version of Grafana is released. When a Grafana version becomes unsupported, Grafana Labs might also drop support for that database version. See the links above for the support policies for each project.

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 PostgreSQL versions 10.9, 11.4, and 12-beta2 are affected by a bug (tracked by the PostgreSQL project as [bug #15865](https://www.postgresql.org/message-id/flat/15865-17940eacc8f8b081%40postgresql.org)) which prevents those versions from being used with Grafana. The bug has been fixed in more recent versions of PostgreSQL.
-{{% /admonition %}}
+{{< /admonition >}}

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 Grafana binaries and images might not work with unsupported databases, even if they claim to be drop-in or replicate the API to their best.
 Binaries and images built with [BoringCrypto](https://pkg.go.dev/crypto/internal/boring) may have different problems than other distributions of Grafana.
-{{% /admonition %}}
+{{< /admonition >}}

 > Grafana can report errors when relying on read-only MySQL servers, such as in high-availability failover scenarios or serverless AWS Aurora MySQL. This is a known issue; for more information, see [issue #13399](https://github.com/grafana/grafana/issues/13399).

@@ -87,9 +87,9 @@ Binaries and images built with [BoringCrypto](https://pkg.go.dev/crypto/internal

 Grafana supports the current version of the following browsers. Older versions of these browsers might not be supported, so you should always upgrade to the latest browser version when using Grafana.

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 Enable JavaScript in your browser. Running Grafana without JavaScript enabled in the browser is not supported.
-{{% /admonition %}}
+{{< /admonition >}}

 - Chrome/Chromium
 - Firefox
@@ -364,7 +364,9 @@ volumes:
  grafana_storage: {}
 ```

-> **Note:** If you want to specify the version of a plugin, add the version number to the `GF_PLUGINS_PREINSTALL` environment variable. For example: `-e "GF_PLUGINS_PREINSTALL=grafana-clock-panel@1.0.1,grafana-simple-json-datasource@1.3.5"`. If you do not specify a version number, the latest version is used.
+{{< admonition type="note" >}}
+If you want to specify the version of a plugin, add the version number to the `GF_PLUGINS_PREINSTALL` environment variable. For example: `-e "GF_PLUGINS_PREINSTALL=grafana-clock-panel@1.0.1,grafana-simple-json-datasource@1.3.5"`. If you do not specify a version number, the latest version is used.
+{{< /admonition >}}

 ## Next steps

@@ -199,9 +199,9 @@ In order to make any configuration changes, download the `values.yaml` file from

 https://github.com/grafana/helm-charts/blob/main/charts/grafana/values.yaml

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 Depending on your use case requirements, you can use a single YAML file that contains your configuration changes or you can create multiple YAML files.
-{{% /admonition %}}
+{{< /admonition >}}

 ### Enable persistent storage **(recommended)**