From 80a2f701bf25b3cd16ba901407e4297457653fcc Mon Sep 17 00:00:00 2001 From: "grafana-delivery-bot[bot]" <132647405+grafana-delivery-bot[bot]@users.noreply.github.com> Date: Mon, 23 Oct 2023 10:55:22 +0300 Subject: [PATCH] [v10.0.x] Docs: Add missing step to install plugin doc (#76939) * Docs: Add missing step to install plugin doc (#76853) Add missing step to install plugin doc (cherry picked from commit 03bf6d6ed44804497ed274c9b0e0999df0c935d2) * Fix codespell issues Signed-off-by: Jack Baldry --------- Signed-off-by: Jack Baldry Co-authored-by: Rob Whelan Co-authored-by: Jack Baldry --- .codespellignore | 3 ++- docs/sources/administration/api-keys/index.md | 2 +- docs/sources/administration/plugin-management/index.md | 1 + docs/sources/administration/provisioning/index.md | 4 ++-- .../fundamentals/alert-rules/message-templating.md | 10 +++++----- .../file-provisioning/index.md | 2 +- .../terraform-provisioning/index.md | 2 +- .../panels-visualizations/calculation-types/index.md | 2 +- .../query-transform-data/transform-data/index.md | 2 +- .../sources/release-notes/release-notes-9-1-0-beta1.md | 2 +- .../configure-authentication/jwt/index.md | 2 +- .../configure-authentication/okta/index.md | 2 +- docs/sources/setup-grafana/set-up-https.md | 2 +- 13 files changed, 19 insertions(+), 17 deletions(-) diff --git a/.codespellignore b/.codespellignore index c5e27e97f15..3e5680389e9 100644 --- a/.codespellignore +++ b/.codespellignore @@ -1,4 +1,5 @@ aks eror iam -wan \ No newline at end of file +wan +operato diff --git a/docs/sources/administration/api-keys/index.md b/docs/sources/administration/api-keys/index.md index 3352002fd68..f2e1be18e75 100644 --- a/docs/sources/administration/api-keys/index.md +++ b/docs/sources/administration/api-keys/index.md @@ -135,7 +135,7 @@ Complete the following steps to migrate from API keys to service accounts for AP This action generates a service account token. 1. Store the ID and secret that the system returns to you. -1. Pass the token in the `Authrorization` header, prefixed with `Bearer`. +1. Pass the token in the `Authorization` header, prefixed with `Bearer`. This action authenticates API requests. diff --git a/docs/sources/administration/plugin-management/index.md b/docs/sources/administration/plugin-management/index.md index 250e9c25d43..1d8f901c952 100644 --- a/docs/sources/administration/plugin-management/index.md +++ b/docs/sources/administration/plugin-management/index.md @@ -100,6 +100,7 @@ To browse for available plugins: To install a plugin: 1. In Grafana, click **Administration > Plugins** in the side navigation menu to view installed plugins. +1. Click the **All** filter to browse all available plugins. 1. Browse and find a plugin. 1. Click on the plugin logo. 1. Click **Install**. diff --git a/docs/sources/administration/provisioning/index.md b/docs/sources/administration/provisioning/index.md index cb1e7bb7fb8..72d9494f383 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -370,8 +370,8 @@ By default, Grafana deletes dashboards in the database if the file is removed. Y {{% admonition type="note" %}} Provisioning allows you to overwrite existing dashboards -which leads to problems if you re-use settings that are supposed to be unique. -Be careful not to re-use the same `title` multiple times within a folder +which leads to problems if you reuse settings that are supposed to be unique. +Be careful not to reuse the same `title` multiple times within a folder or `uid` within the same installation as this will cause weird behaviors. {{% /admonition %}} diff --git a/docs/sources/alerting/fundamentals/alert-rules/message-templating.md b/docs/sources/alerting/fundamentals/alert-rules/message-templating.md index a07b891debb..cad151fcd9c 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/message-templating.md +++ b/docs/sources/alerting/fundamentals/alert-rules/message-templating.md @@ -59,11 +59,11 @@ Alert summary: You can use any of the following built-in template options to embed custom templates. -| Name | Notes | -| ----------------------- | ------------------------------------------------------------- | -| `default.title` | Displays high-level status information. | -| `default.message` | Provides a formatted summary of firing and resolved alerts. | -| `teams.default.message` | Similar to `default.messsage`, formatted for Microsoft Teams. | +| Name | Notes | +| ----------------------- | ------------------------------------------------------------ | +| `default.title` | Displays high-level status information. | +| `default.message` | Provides a formatted summary of firing and resolved alerts. | +| `teams.default.message` | Similar to `default.message`, formatted for Microsoft Teams. | ### HTML in notification templates diff --git a/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md b/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md index 877ae0dc1ce..38f574ef591 100644 --- a/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md +++ b/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md @@ -72,7 +72,7 @@ groups: # which query should be used for the condition condition: A # list of query objects that should be executed on each - # evaluation - should be obtained trough the API + # evaluation - should be obtained through the API data: - refId: A datasourceUid: '__expr__' diff --git a/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md b/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md index 36b2232f951..b60a220c4a8 100644 --- a/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md +++ b/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md @@ -115,7 +115,7 @@ You cannot edit resources provisioned via Terraform from the UI. This ensures th **Note:** -You can re-use the same templates across many contact points. In the example above, a shared template ie embedded using the statement `{{ template “Alert Instance Template” . }}` +You can reuse the same templates across many contact points. In the example above, a shared template ie embedded using the statement `{{ template “Alert Instance Template” . }}` This fragment can then be managed separately in Terraform: diff --git a/docs/sources/panels-visualizations/calculation-types/index.md b/docs/sources/panels-visualizations/calculation-types/index.md index 316fe512ac7..7aaa8d7a648 100644 --- a/docs/sources/panels-visualizations/calculation-types/index.md +++ b/docs/sources/panels-visualizations/calculation-types/index.md @@ -20,7 +20,7 @@ The following table contains a list of calculations you can perform in Grafana. | :----------------- | :-------------------------------------------------------- | | All nulls | True when all values are null | | All values | Array with all values | -| All unique values | Array with all unique alues | +| All unique values | Array with all unique values | | All zeros | True when all values are 0 | | Change count | Number of times the field's value changes | | Count | Number of values in a field | diff --git a/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md b/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md index 761f73edb8d..e1905bc5657 100644 --- a/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md +++ b/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md @@ -868,7 +868,7 @@ Output: The extra labels can now be used in the field display name provide more complete field names. -If you want to extract config from one query and appply it to another you should use the config from query results transformation. +If you want to extract config from one query and apply it to another you should use the config from query results transformation. #### Example diff --git a/docs/sources/release-notes/release-notes-9-1-0-beta1.md b/docs/sources/release-notes/release-notes-9-1-0-beta1.md index 8e4758f105c..8f24c8bfb36 100644 --- a/docs/sources/release-notes/release-notes-9-1-0-beta1.md +++ b/docs/sources/release-notes/release-notes-9-1-0-beta1.md @@ -202,7 +202,7 @@ The following metrics have been converted to histograms: - grafana_plugin_request_duration_milliseconds - grafana_alerting_rule_evaluation_duration_seconds Issue [#50420](https://github.com/grafana/grafana/issues/50420) -In Elasticsearch versions 7.x, to specify the interval-value we used the `interval` property. In Grafana 9.1.0 we switched to use the `fixed_interval` property. This makes it to be the same as in Elasticsearch versions 8.x, also this provides a more consistent experience, `fixed_interval` is a better match to Grafana's time invervals. For most situations this will not cause any visible change to query results. Issue [#50297](https://github.com/grafana/grafana/issues/50297) +In Elasticsearch versions 7.x, to specify the interval-value we used the `interval` property. In Grafana 9.1.0 we switched to use the `fixed_interval` property. This makes it to be the same as in Elasticsearch versions 8.x, also this provides a more consistent experience, `fixed_interval` is a better match to Grafana's time intervals. For most situations this will not cause any visible change to query results. Issue [#50297](https://github.com/grafana/grafana/issues/50297) ### Grafana now reserves alert labels prefixed with `grafana_` diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md index d90e0813139..4d87e6d7008 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md @@ -64,7 +64,7 @@ If `auto_sign_up` is enabled, then the `sub` claim is used as the "external Auth ## Iframe Embedding -If you want to embed Grafana in an iframe while maintaning user identity and role checks, +If you want to embed Grafana in an iframe while maintaining user identity and role checks, you can use JWT authentication to authenticate the iframe. {{% admonition type="note" %}} diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md index f0901910eda..87e658a2538 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md @@ -131,4 +131,4 @@ the correct teams. Okta groups can be referenced by group names, like `Admins` or `Editors`. -To learn more about Team Sync, refer to [Confgure Team Sync]({{< relref "../../configure-team-sync" >}}). +To learn more about Team Sync, refer to [Configure Team Sync]({{< relref "../../configure-team-sync" >}}). diff --git a/docs/sources/setup-grafana/set-up-https.md b/docs/sources/setup-grafana/set-up-https.md index 8de9c663618..20ce98bb2a0 100644 --- a/docs/sources/setup-grafana/set-up-https.md +++ b/docs/sources/setup-grafana/set-up-https.md @@ -70,7 +70,7 @@ This section shows you how to use `openssl` tooling to generate all necessary fi Country Name (2 letter code) [AU]:US State or Province Name (full name) [Some-State]:Virginia Locality Name (eg, city) []:Richmond - Organization Name (eg, company) [Internet Widgits Pty Ltd]: + Organization Name (eg, company) [Internet Pty Ltd]: Organizational Unit Name (eg, section) []: Common Name (e.g. server FQDN or YOUR name) []:subdomain.mysite.com Email Address []:me@mysite.com