From 4432c4c75ccf830d0ebd6413da08a9124846542b Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 3 Oct 2023 13:49:27 +0100 Subject: [PATCH] Fix developer links and newly discovered spelling errors (#75875) * Fix developer links Signed-off-by: Jack Baldry * Fix newly discovered spelling errors Signed-off-by: Jack Baldry --------- Signed-off-by: Jack Baldry --- docs/sources/administration/api-keys/index.md | 2 +- .../administration/provisioning/index.md | 4 ++-- .../alert-rules/message-templating.md | 10 ++++----- .../terraform-provisioning/index.md | 2 +- .../developers/angular_deprecation/_index.md | 2 +- docs/sources/developers/http_api/alerting.md | 12 +++++++++-- .../developers/http_api/dashboard_public.md | 17 +++++++++------ docs/sources/developers/http_api/user.md | 21 ++++++++++++------- .../calculation-types/index.md | 2 +- .../transform-data/index.md | 2 +- .../release-notes-9-1-0-beta1.md | 2 +- .../feature-toggles/index.md | 2 +- .../configure-authentication/jwt/index.md | 2 +- docs/sources/setup-grafana/set-up-https.md | 2 +- 14 files changed, 50 insertions(+), 32 deletions(-) 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/provisioning/index.md b/docs/sources/administration/provisioning/index.md index 7e3d90f15ec..3aa08798bff 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -371,8 +371,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/terraform-provisioning/index.md b/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md index 5b6cba096c4..00da7920444 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 @@ -138,7 +138,7 @@ By default, you cannot edit resources provisioned via Terraform from the UI. Thi **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/developers/angular_deprecation/_index.md b/docs/sources/developers/angular_deprecation/_index.md index cf7fd5235fe..89b3037c1ae 100644 --- a/docs/sources/developers/angular_deprecation/_index.md +++ b/docs/sources/developers/angular_deprecation/_index.md @@ -40,7 +40,7 @@ We encourage you to locate the repository of the corresponding plugin and create ### Links -- [Migrate Angular to React]({{< relref "../plugins/migration-guide/angular-react/" >}}) +- [Migrate Angular to React](https://grafana.com/developers/plugin-tools/migration-guides/migrate-angularjs-to-react) - [Build a panel plugin](https://grafana.com/tutorials/build-a-panel-plugin/) - [Build a data source plugin](https://grafana.com/tutorials/build-a-data-source-plugin/) - [List of current Angular plugins]({{< relref "./angular-plugins/" >}}) diff --git a/docs/sources/developers/http_api/alerting.md b/docs/sources/developers/http_api/alerting.md index f05d79a5ba2..ceece602a88 100644 --- a/docs/sources/developers/http_api/alerting.md +++ b/docs/sources/developers/http_api/alerting.md @@ -27,7 +27,7 @@ This topic is relevant for the [legacy dashboard alerts](/docs/grafana/v8.5/aler If you are using Grafana Alerting, refer to [Alerting provisioning API]({{< relref "./alerting_provisioning" >}}) -You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation]({{< relref "../../alerting" >}}) for details on how to create and manage new alerts. +You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation][] for details on how to create and manage new alerts. You can use the Alerting API to get information about legacy dashboard alerts and their states but this API cannot be used to modify the alert. To create new alerts or modify them you need to update the dashboard JSON that contains the alerts. @@ -173,4 +173,12 @@ Content-Type: application/json ## Pause all alerts -See [Admin API]({{< relref "/docs/grafana/latest/developers/http_api/admin#pause-all-alerts" >}}). +See [Admin API][]. + +{{% docs/reference %}} +[Admin API]: "/docs/grafana/ -> /docs/grafana//developers/http_api/admin#pause-all-alerts" +[Admin API]: "/docs/grafana/ -> /docs/grafana//developers/http_api/admin#pause-all-alerts" + +[Grafana Alerting alerts documentation]: "/docs/grafana/ -> /docs/grafana//alerting" +[Grafana Alerting alerts documentation]: "/docs/grafana-cloud/ -> /docs/grafana//alerting" +{{% /docs/reference %}} diff --git a/docs/sources/developers/http_api/dashboard_public.md b/docs/sources/developers/http_api/dashboard_public.md index 410980aad84..58156722302 100644 --- a/docs/sources/developers/http_api/dashboard_public.md +++ b/docs/sources/developers/http_api/dashboard_public.md @@ -20,7 +20,7 @@ title: Public Dashboard HTTP API {{% admonition type="note" %}} -If you're running Grafana Enterprise, you'll need to have specific permissions for some endpoints. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +If you're running Grafana Enterprise, you'll need to have specific permissions for some endpoints. Refer to [Role-based access control permissions][] for more information. {{% /admonition %}} @@ -32,7 +32,7 @@ Creates a new public dashboard. **Required permissions** -See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation. +See note in the [introduction](#public-dashboard-api) for an explanation. | Action | Scope | | ------------------------- | -------------------------------- | @@ -115,7 +115,7 @@ Content-Length: 107 **Required permissions** -See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation. +See note in the [introduction](#public-dashboard-api) for an explanation. | Action | Scope | | ------------------------- | -------------------------------- | @@ -196,7 +196,7 @@ Will return the public dashboard given the dashboard unique identifier (uid). **Required permissions** -See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation. +See note in the [introduction](#public-dashboard-api) for an explanation. | Action | Scope | | ----------------- | -------------------------------- | @@ -247,7 +247,7 @@ Will delete the public dashboard given the specified unique identifier (uid). **Required permissions** -See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation. +See note in the [introduction](#public-dashboard-api) for an explanation. | Action | Scope | | ------------------------- | -------------------------------- | @@ -274,7 +274,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation. +See note in the [introduction](#public-dashboard-api) for an explanation. | Action | Scope | | ----------------- | -------------------------------- | @@ -317,3 +317,8 @@ Content-Type: application/json "perPage": 2 } ``` + +{{% docs/reference %}} +[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" +[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" +{{% /docs/reference %}} diff --git a/docs/sources/developers/http_api/user.md b/docs/sources/developers/http_api/user.md index ce2dfd122e4..1443f72b1b4 100644 --- a/docs/sources/developers/http_api/user.md +++ b/docs/sources/developers/http_api/user.md @@ -24,7 +24,7 @@ user must have the Grafana Admin role. API Tokens can be used with Organization HTTP API to get users of specific organization. -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions][] for more information. ## Search Users @@ -32,7 +32,7 @@ API Tokens can be used with Organization HTTP API to get users of specific organ **Required permissions** -See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. +See note in the [introduction](#user-api) for an explanation. | Action | Scope | | ---------- | --------------- | @@ -89,7 +89,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. +See note in the [introduction](#user-api) for an explanation. | Action | Scope | | ---------- | --------------- | @@ -152,7 +152,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. +See note in the [introduction](#user-api) for an explanation. | Action | Scope | | ---------- | --------------- | @@ -198,7 +198,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. +See note in the [introduction](#user-api) for an explanation. | Action | Scope | | ---------- | --------------- | @@ -253,7 +253,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. +See note in the [introduction](#user-api) for an explanation. | Action | Scope | | ----------- | --------------- | @@ -292,7 +292,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. +See note in the [introduction](#user-api) for an explanation. | Action | Scope | | ---------- | --------------- | @@ -330,7 +330,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. +See note in the [introduction](#user-api) for an explanation. | Action | Scope | | ---------- | --------------- | @@ -683,3 +683,8 @@ Content-Type: application/json "message": "User auth token revoked" } ``` + +{{% docs/reference %}} +[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" +[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" +{{% /docs/reference %}} 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 bd76bb1c643..210b23b989d 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 @@ -874,7 +874,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-grafana/feature-toggles/index.md b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md index c24db60f117..71ff650d3be 100644 --- a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md +++ b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md @@ -120,7 +120,7 @@ Experimental features might be changed or removed without prior notice. | `lokiFormatQuery` | Enables the ability to format Loki queries | | `exploreScrollableLogsContainer` | Improves the scrolling behavior of logs in Explore | | `pluginsDynamicAngularDetectionPatterns` | Enables fetching Angular detection patterns for plugins from GCOM and fallback to hardcoded ones | -| `vizAndWidgetSplit` | Split panels between vizualizations and widgets | +| `vizAndWidgetSplit` | Split panels between visualizations and widgets | | `prometheusIncrementalQueryInstrumentation` | Adds RudderStack events to incremental queries | | `logsExploreTableVisualisation` | A table visualisation for logs in Explore | | `awsDatasourcesTempCredentials` | Support temporary security credentials in AWS plugins for Grafana Cloud customers | 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 39de9c4f2a7..b182ba873e2 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/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