From 820eb5c80eb32cdf69b06409714fc76fc1c044fc Mon Sep 17 00:00:00 2001 From: Amal <56926487+amalkurup89@users.noreply.github.com> Date: Tue, 19 May 2020 02:26:23 +0530 Subject: [PATCH] Docs: Correcting abbreviations (#24748) * Correction in abbreviation * Minor correction in abbreviation * Correcting abbreviation * Correction in abbreviation * Correcting abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Update stack_guide_graphite.md * Update whats-new-in-v4-6.md * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Update ldap.md * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Correction in abbreviation * Update docs/sources/guides/whats-new-in-v5.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> --- docs/sources/auth/generic-oauth.md | 2 +- docs/sources/auth/ldap.md | 16 ++++++++-------- docs/sources/auth/overview.md | 4 ++-- docs/sources/features/datasources/graphite.md | 2 +- docs/sources/features/datasources/opentsdb.md | 2 +- docs/sources/guides/whats-new-in-v2-1.md | 2 +- docs/sources/guides/whats-new-in-v4-2.md | 4 ++-- docs/sources/guides/whats-new-in-v4-5.md | 2 +- docs/sources/guides/whats-new-in-v4-6.md | 6 +++--- docs/sources/guides/whats-new-in-v5.md | 4 ++-- docs/sources/guides/whats-new-in-v6-1.md | 2 +- docs/sources/guides/whats-new-in-v6-6.md | 2 +- docs/sources/http_api/auth.md | 4 ++-- docs/sources/installation/configuration.md | 8 ++++---- docs/sources/tutorials/stack_guide_graphite.md | 6 +++--- 15 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/sources/auth/generic-oauth.md b/docs/sources/auth/generic-oauth.md index fc675441eef..872e087150b 100755 --- a/docs/sources/auth/generic-oauth.md +++ b/docs/sources/auth/generic-oauth.md @@ -12,7 +12,7 @@ weight = 3 # Generic OAuth Authentication -You can configure many different oauth2 authentication services with Grafana using the generic oauth2 feature. Below you +You can configure many different OAuth2 authentication services with Grafana using the generic OAuth2 feature. Below you can find examples using Okta, BitBucket, OneLogin and Azure. This callback URL must match the full HTTP address that you use in your browser to access Grafana, but with the prefix path of `/login/generic_oauth`. diff --git a/docs/sources/auth/ldap.md b/docs/sources/auth/ldap.md index a94905c9f53..bdd9b75cbc0 100644 --- a/docs/sources/auth/ldap.md +++ b/docs/sources/auth/ldap.md @@ -37,8 +37,8 @@ enabled = true # Path to the LDAP specific configuration file (default: `/etc/grafana/ldap.toml`) config_file = /etc/grafana/ldap.toml -# Allow sign up should almost always be true (default) to allow new Grafana users to be created (if ldap authentication is ok). If set to -# false only pre-existing Grafana users will be able to login (if ldap authentication is ok). +# Allow sign up should almost always be true (default) to allow new Grafana users to be created (if LDAP authentication is ok). If set to +# false only pre-existing Grafana users will be able to login (if LDAP authentication is ok). allow_sign_up = true ``` @@ -54,11 +54,11 @@ See [configuration examples](#configuration-examples) for more information. host = "127.0.0.1" # Default port is 389 or 636 if use_ssl = true port = 389 -# Set to true if ldap server supports TLS +# Set to true if LDAP server supports TLS use_ssl = false -# Set to true if connect ldap server with STARTTLS pattern (create connection in insecure, then upgrade to secure connection with TLS) +# Set to true if connect LDAP server with STARTTLS pattern (create connection in insecure, then upgrade to secure connection with TLS) start_tls = false -# set to true if you want to skip ssl cert validation +# set to true if you want to skip SSL cert validation ssl_skip_verify = false # set to the path to your root CA certificate or leave unset to use system defaults # root_ca_cert = "/path/to/certificate.crt" @@ -83,7 +83,7 @@ search_base_dns = ["dc=grafana,dc=org"] # group_search_filter_user_attribute = "distinguishedName" # group_search_base_dns = ["ou=groups,dc=grafana,dc=org"] -# Specify names of the ldap attributes your ldap uses +# Specify names of the LDAP attributes your LDAP uses [servers.attributes] name = "givenName" surname = "sn" @@ -144,7 +144,7 @@ In this case you skip providing a `bind_password` and instead provide a `bind_dn The search filter and search bases settings are still needed to perform the LDAP search to retrieve the other LDAP information (like LDAP groups and email). ### POSIX schema -If your ldap server does not support the memberOf attribute add these options: +If your LDAP server does not support the memberOf attribute add these options: ```bash ## Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available) @@ -355,7 +355,7 @@ Please inspect your Active Directory configuration and documentation to find the ## Troubleshooting -To troubleshoot and get more log info enable ldap debug logging in the [main config file]({{< relref "../installation/configuration.md" >}}). +To troubleshoot and get more log info enable LDAP debug logging in the [main config file]({{< relref "../installation/configuration.md" >}}). ```bash [log] diff --git a/docs/sources/auth/overview.md b/docs/sources/auth/overview.md index 15512dd0f3d..53ef293b2c2 100644 --- a/docs/sources/auth/overview.md +++ b/docs/sources/auth/overview.md @@ -68,7 +68,7 @@ login_maximum_lifetime_days = 30 # How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes. token_rotation_interval_minutes = 10 -# The maximum lifetime (seconds) an api key can be used. If it is set all the api keys should have limited lifetime that is lower than this value. +# The maximum lifetime (seconds) an API key can be used. If it is set all the API keys should have limited lifetime that is lower than this value. api_key_max_seconds_to_live = -1 ``` @@ -134,7 +134,7 @@ disable_signout_menu = true ### URL redirect after signing out -URL to redirect the user to after signing out from Grafana. This can for example be used to enable signout from oauth provider. +URL to redirect the user to after signing out from Grafana. This can for example be used to enable signout from OAuth provider. ```bash [auth] diff --git a/docs/sources/features/datasources/graphite.md b/docs/sources/features/datasources/graphite.md index 637da2667a9..acf5f56f5c6 100755 --- a/docs/sources/features/datasources/graphite.md +++ b/docs/sources/features/datasources/graphite.md @@ -104,7 +104,7 @@ Query | Description *tag_values(server, server=~backend\*)* | Returns filtered tag values that occur for the specified tag in series matching those expressions. *tag_values(server, server=~backend\*, app=~${apps:regex})* | Multiple filter expressions and expressions can contain other variables. -For more details, see the [Graphite docs on the autocomplete api for tags](http://graphite.readthedocs.io/en/latest/tags.html#auto-complete-support). +For more details, see the [Graphite docs on the autocomplete API for tags](http://graphite.readthedocs.io/en/latest/tags.html#auto-complete-support). ### Query variable diff --git a/docs/sources/features/datasources/opentsdb.md b/docs/sources/features/datasources/opentsdb.md index 4c878b22167..061bcb6f5aa 100644 --- a/docs/sources/features/datasources/opentsdb.md +++ b/docs/sources/features/datasources/opentsdb.md @@ -45,7 +45,7 @@ can be used to query opentsdb. Fill Policy is also introduced in OpenTSDB 2.2. ### Auto complete suggestions As soon as you start typing metric names, tag names and tag values , you should see highlighted auto complete suggestions for them. -The autocomplete only works if the OpenTSDB suggest api is enabled. +The autocomplete only works if the OpenTSDB suggest API is enabled. ## Templating queries diff --git a/docs/sources/guides/whats-new-in-v2-1.md b/docs/sources/guides/whats-new-in-v2-1.md index b71ecf51bfc..6eedbe2b719 100644 --- a/docs/sources/guides/whats-new-in-v2-1.md +++ b/docs/sources/guides/whats-new-in-v2-1.md @@ -92,7 +92,7 @@ Grafana OpenTSDB data source now supports template variable values queries. This template variables that fetches the values from OpenTSDB (for example metric names, tag names, or tag values). The query editor is also enhanced to limiting tags by metric. -> ***Note:*** OpenTSDB config option tsd.core.meta.enable_realtime_ts must enabled for OpenTSDB lookup api) +> ***Note:*** OpenTSDB config option tsd.core.meta.enable_realtime_ts must enabled for OpenTSDB lookup API) ### New Data Source: KairosDB The Cassandra backed time series database KairosDB is now supported in Grafana out of the box. Thank you to diff --git a/docs/sources/guides/whats-new-in-v4-2.md b/docs/sources/guides/whats-new-in-v4-2.md index 7cac5ef7dcc..2be9854506c 100644 --- a/docs/sources/guides/whats-new-in-v4-2.md +++ b/docs/sources/guides/whats-new-in-v4-2.md @@ -67,9 +67,9 @@ Making it possible to have users in multiple groups and have detailed access con ## Upgrade and Breaking changes -If you're using https in grafana we now force you to use tls 1.2 and the most secure ciphers. +If you're using HTTPS in grafana we now force you to use TLS 1.2 and the most secure ciphers. We think its better to be secure by default rather then making it configurable. -If you want to run https with lower versions of tls we suggest you put a reserve proxy in front of grafana. +If you want to run HTTPS with lower versions of TLS we suggest you put a reserve proxy in front of grafana. If you have template variables name `$__interval` or `$__interval_ms` they will no longer work since these keywords are reserved as global built in variables. We might add more global built in variables in the future and if we do, we will prefix them with `$__`. So please avoid using that in your template variables. diff --git a/docs/sources/guides/whats-new-in-v4-5.md b/docs/sources/guides/whats-new-in-v4-5.md index f4496fc21a6..31a201352ba 100644 --- a/docs/sources/guides/whats-new-in-v4-5.md +++ b/docs/sources/guides/whats-new-in-v4-5.md @@ -45,7 +45,7 @@ More information [here](https://community.grafana.com/t/using-grafanas-query-ins ### Enhancements * **GitHub OAuth**: Support for GitHub organizations with 100+ teams. [#8846](https://github.com/grafana/grafana/issues/8846), thx [@skwashd](https://github.com/skwashd) -* **Graphite**: Calls to Graphite api /metrics/find now include panel or dashboard time range (from and until) in most cases, [#8055](https://github.com/grafana/grafana/issues/8055) +* **Graphite**: Calls to Graphite API /metrics/find now include panel or dashboard time range (from and until) in most cases, [#8055](https://github.com/grafana/grafana/issues/8055) * **Graphite**: Added new graphite 1.0 functions, available if you set version to 1.0.x in data source settings. New Functions: mapSeries, reduceSeries, isNonNull, groupByNodes, offsetToZero, grep, weightedAverage, removeEmptySeries, aggregateLine, averageOutsidePercentile, delay, exponentialMovingAverage, fallbackSeries, integralByInterval, interpolate, invert, linearRegression, movingMin, movingMax, movingSum, multiplySeriesWithWildcards, pow, powSeries, removeBetweenPercentile, squareRoot, timeSlice, closes [#8261](https://github.com/grafana/grafana/issues/8261) - **Elasticsearch**: Ad-hoc filters now use query phrase match filters instead of term filters, works on non keyword/raw fields [#9095](https://github.com/grafana/grafana/issues/9095). diff --git a/docs/sources/guides/whats-new-in-v4-6.md b/docs/sources/guides/whats-new-in-v4-6.md index 57298cdf441..d713bfa3cb6 100644 --- a/docs/sources/guides/whats-new-in-v4-6.md +++ b/docs/sources/guides/whats-new-in-v4-6.md @@ -60,9 +60,9 @@ This makes exploring and filtering Prometheus data much easier. ### Minor Changes -* **SMTP**: Make it possible to set specific EHLO for smtp client. [#9319](https://github.com/grafana/grafana/issues/9319) -* **Dataproxy**: Allow Grafana to renegotiate tls connection [#9250](https://github.com/grafana/grafana/issues/9250) -* **HTTP**: set net.Dialer.DualStack to true for all http clients [#9367](https://github.com/grafana/grafana/pull/9367) +* **SMTP**: Make it possible to set specific EHLO for SMTP client. [#9319](https://github.com/grafana/grafana/issues/9319) +* **Dataproxy**: Allow Grafana to renegotiate TLS connection [#9250](https://github.com/grafana/grafana/issues/9250) +* **HTTP**: set net.Dialer.DualStack to true for all HTTP clients [#9367](https://github.com/grafana/grafana/pull/9367) * **Alerting**: Add diff and percent diff as series reducers [#9386](https://github.com/grafana/grafana/pull/9386), thx [@shanhuhai5739](https://github.com/shanhuhai5739) * **Slack**: Allow images to be uploaded to slack when Token is present [#7175](https://github.com/grafana/grafana/issues/7175), thx [@xginn8](https://github.com/xginn8) * **Opsgenie**: Use their latest API instead of old version [#9399](https://github.com/grafana/grafana/pull/9399), thx [@cglrkn](https://github.com/cglrkn) diff --git a/docs/sources/guides/whats-new-in-v5.md b/docs/sources/guides/whats-new-in-v5.md index 1fec2067328..821d1042061 100644 --- a/docs/sources/guides/whats-new-in-v5.md +++ b/docs/sources/guides/whats-new-in-v5.md @@ -22,7 +22,7 @@ This is the most substantial update that Grafana has ever seen. This article wil - [Group users into teams]({{< relref "#teams" >}}) and use them in the new permission system. - [Data source provisioning]({{< relref "#data-sources" >}}) makes it possible to setup data sources via config files. - [Dashboard provisioning]({{< relref "#dashboards" >}}) makes it possible to setup dashboards via config files. -- [Persistent dashboard url's]({{< relref "#dashboard-model-persistent-url-s-and-api-changes" >}}) makes it possible to rename dashboards without breaking links. +- [Persistent dashboard URL's]({{< relref "#dashboard-model-persistent-url-s-and-api-changes" >}}) makes it possible to rename dashboards without breaking links. - [Graphite Tags and Integrated Function Docs]({{< relref "#graphite-tags-integrated-function-docs" >}}). ### Video showing new features @@ -129,7 +129,7 @@ Read more on [Graphite Tag Support](http://graphite.readthedocs.io/en/latest/tag
-## Dashboard model, persistent url's and API changes +## Dashboard model, persistent URLs and API changes We are introducing a new unique identifier (`uid`) in the dashboard JSON model. It's automatically generated if not provided when creating a dashboard and will have a length of 9-12 characters. diff --git a/docs/sources/guides/whats-new-in-v6-1.md b/docs/sources/guides/whats-new-in-v6-1.md index bf3dcb28b13..3ac5fa820f9 100644 --- a/docs/sources/guides/whats-new-in-v6-1.md +++ b/docs/sources/guides/whats-new-in-v6-1.md @@ -50,7 +50,7 @@ This release contains a lot of small features and fixes: - A new keyboard shortcut `d l` toggles all Graph legends in a dashboard. - A small bug fix for Elasticsearch - template variables in the alias field now work properly. - Some new capabilities have been added for data source plugins that will be of interest to plugin authors: - - a new oauth pass-through option. + - a new OAuth pass-through option. - it is now possible to add user details to requests sent to the dataproxy. - Heatmap and Explore fixes. diff --git a/docs/sources/guides/whats-new-in-v6-6.md b/docs/sources/guides/whats-new-in-v6-6.md index 7988ebdec5d..226dd45e9e4 100644 --- a/docs/sources/guides/whats-new-in-v6-6.md +++ b/docs/sources/guides/whats-new-in-v6-6.md @@ -188,7 +188,7 @@ From now on it will be possible to utilize meta data label in group bys, filters ## CloudWatch: Calculate period based on time range -When the period field was left blank in Grafana 6.5, it would default to 60 seconds. In case users issued queries with a large time span, there was a high risk that they would reach the 100,800 data points per request limit in the Get Metric Data (GMD) api. When the period field is left blank in Grafana 6.6, the period will be calculated automatically based on the time range. The formula that is used is `time range in seconds / 2000`, and then we snap to next higher value in an array of pre-defined periods `[60, 300, 900, 3600, 21600, 86400]`. This will reduce the risk for receiving a `Too many datapoints requested` error in the panel. +When the period field was left blank in Grafana 6.5, it would default to 60 seconds. In case users issued queries with a large time span, there was a high risk that they would reach the 100,800 data points per request limit in the Get Metric Data (GMD) API. When the period field is left blank in Grafana 6.6, the period will be calculated automatically based on the time range. The formula that is used is `time range in seconds / 2000`, and then we snap to next higher value in an array of pre-defined periods `[60, 300, 900, 3600, 21600, 86400]`. This will reduce the risk for receiving a `Too many datapoints requested` error in the panel. ## CloudWatch: Display partial result in graph when max data points per call limit is reached diff --git a/docs/sources/http_api/auth.md b/docs/sources/http_api/auth.md index 6fa09820643..a619ef325f9 100755 --- a/docs/sources/http_api/auth.md +++ b/docs/sources/http_api/auth.md @@ -13,7 +13,7 @@ parent = "http_api" ## Tokens -Currently you can authenticate via an `API Token` or via a `Session cookie` (acquired using regular login or oauth). +Currently you can authenticate via an `API Token` or via a `Session cookie` (acquired using regular login or OAuth). ## Basic Auth @@ -150,4 +150,4 @@ HTTP/1.1 200 Content-Type: application/json {"message":"API key deleted"} -``` \ No newline at end of file +``` diff --git a/docs/sources/installation/configuration.md b/docs/sources/installation/configuration.md index 48e751dae6d..ab1ad8b77de 100644 --- a/docs/sources/installation/configuration.md +++ b/docs/sources/installation/configuration.md @@ -42,7 +42,7 @@ Semicolons (the `;` char) are the standard way to comment out lines in a `.ini` **Example** ``` -# The http port to use +# The HTTP port to use ;http_port = 3000 ``` @@ -146,7 +146,7 @@ Another way is put a webserver like Nginx or Apache in front of Grafana and have `http`,`https`,`h2` or `socket` -> **Note:** Grafana versions earlier than 3.0 are vulnerable to [POODLE](https://en.wikipedia.org/wiki/POODLE). So we strongly recommend to upgrade to 3.x or use a reverse proxy for ssl termination. +> **Note:** Grafana versions earlier than 3.0 are vulnerable to [POODLE](https://en.wikipedia.org/wiki/POODLE). So we strongly recommend to upgrade to 3.x or use a reverse proxy for SSL termination. ### socket Path where the socket should be created when `protocol=socket`. Please make sure that Grafana has appropriate permissions. @@ -549,7 +549,7 @@ File path to a cert file, defaults to `empty` File path to a key file, defaults to `empty` ### skip_verify -Verify SSL for smtp server? defaults to `false` +Verify SSL for SMTP server? defaults to `false` ### from_address Address used when sending out emails, defaults to `admin@grafana.localhost` @@ -638,7 +638,7 @@ Log line format, valid options are text, console and json. Default is `console`. ### network and address -Syslog network type and address. This can be udp, tcp, or unix. If left blank, the default unix endpoints will be used. +Syslog network type and address. This can be UDP, TCP, or unix. If left blank, the default unix endpoints will be used. ### facility diff --git a/docs/sources/tutorials/stack_guide_graphite.md b/docs/sources/tutorials/stack_guide_graphite.md index 0f4357f4232..a6adc85c425 100644 --- a/docs/sources/tutorials/stack_guide_graphite.md +++ b/docs/sources/tutorials/stack_guide_graphite.md @@ -29,7 +29,7 @@ install StatsD, but that is optional. - Carbon is the graphite ingestion daemon responsible for receiving metrics and storing them. -- Graphite-api is light weight version of graphite-web with only the HTTP api and is +- Graphite-api is light weight version of graphite-web with only the HTTP API and is responsible for executing metric queries. - Grafana as the frontend to visualize metrics and the tool to help you build metric queries that will make the most out of your collected metrics. @@ -165,14 +165,14 @@ supervisorctl reload ### Graphite-api -Graphite api is a light weight version of graphite-web with only the api component (no web ui). It is dead simple +Graphite api is a light weight version of graphite-web with only the API component (no web ui). It is dead simple to install. ``` pip install gunicorn graphite-api ``` -You should now have a graphite-api daemon running with an open HTTP api port of 8888. +You should now have a graphite-api daemon running with an open HTTP API port of 8888. ### Configuring Graphite-api