Fix developer links and newly discovered spelling errors (#75875)

* Fix developer links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix newly discovered spelling errors

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
pull/76063/head
Jack Baldry 2 years ago committed by GitHub
parent 3c7c608b5b
commit 4432c4c75c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      docs/sources/administration/api-keys/index.md
  2. 4
      docs/sources/administration/provisioning/index.md
  3. 10
      docs/sources/alerting/fundamentals/alert-rules/message-templating.md
  4. 2
      docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md
  5. 2
      docs/sources/developers/angular_deprecation/_index.md
  6. 12
      docs/sources/developers/http_api/alerting.md
  7. 17
      docs/sources/developers/http_api/dashboard_public.md
  8. 21
      docs/sources/developers/http_api/user.md
  9. 2
      docs/sources/panels-visualizations/calculation-types/index.md
  10. 2
      docs/sources/panels-visualizations/query-transform-data/transform-data/index.md
  11. 2
      docs/sources/release-notes/release-notes-9-1-0-beta1.md
  12. 2
      docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md
  13. 2
      docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md
  14. 2
      docs/sources/setup-grafana/set-up-https.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.

@ -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 %}}

@ -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

@ -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:

@ -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/" >}})

@ -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/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Admin API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Grafana Alerting alerts documentation]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
[Grafana Alerting alerts documentation]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
{{% /docs/reference %}}

@ -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/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
{{% /docs/reference %}}

@ -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/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
{{% /docs/reference %}}

@ -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 |

@ -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

@ -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_`

@ -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 |

@ -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" %}}

@ -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

Loading…
Cancel
Save