-
Notifications
You must be signed in to change notification settings - Fork 12k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Minor edits to the README and several md files #19238
Conversation
Capitalized the G and S in "Getting Started," and moved "guide" to match the section title in the docs.
… changed "get" to "download".
README.md
Outdated
@@ -202,7 +202,7 @@ Debugging all end-to-end tests (BROWSER=1 starts the browser and SLOWMO=1 delays | |||
ENV BROWSER=1 SLOWMO=1 yarn e2e-tests | |||
``` | |||
|
|||
### Datasource and dashboard provisioning | |||
### Data Source and dashboard provisioning |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the S be capitalized here?
docs/sources/enterprise/_index.md
Outdated
@@ -39,9 +39,9 @@ Supported auth providers: | |||
* [GitHub OAuth]({{< relref "auth/github.md#team-sync-enterprise-only" >}}) | |||
* [Auth Proxy]({{< relref "auth/auth-proxy.md#team-sync-enterprise-only">}}) | |||
|
|||
### Datasource Permissions | |||
### Data Source Permissions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably be in sentence case
@@ -251,17 +251,17 @@ it costs $0.01 per 1,000 GetMetricStatistics or ListMetrics requests. For each q | |||
issue a GetMetricStatistics request and every time you pick a dimension in the query editor | |||
Grafana will issue a ListMetrics request. | |||
|
|||
## Configure the Datasource with Provisioning | |||
## Configure the Data Source with Provisioning |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This heading should also be sentence case
|
||
Using a credentials file | ||
```yaml | ||
apiVersion: 1 | ||
|
||
datasources: | ||
data sources: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an example of a YAML file, which would be considered code in this case. With this change, the YAML is not valid anymore, so we should leave this as is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it! Will not touch yaml examples.
@@ -274,7 +274,7 @@ Using `accessKey` and `secretKey` | |||
```yaml | |||
apiVersion: 1 | |||
|
|||
datasources: | |||
data sources: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
YAML again. This should not be changed.
@@ -8,17 +8,17 @@ parent = "developing" | |||
weight = 5 | |||
+++ | |||
|
|||
# Datasources | |||
# Data Sources |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sentence case
@@ -38,15 +38,15 @@ There are two datasource specific settings for the plugin.json | |||
|
|||
These settings indicates what kind of data the plugin can deliver. At least one of them have to be true | |||
|
|||
## Datasource | |||
## Data Source |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sentence case
@@ -155,7 +155,7 @@ A basic guide for data sources can be found [here](http://docs.grafana.org/plugi | |||
|
|||
If possible, any passwords or secrets should be be saved in the `secureJsonData` blob. To encrypt sensitive data, the Grafana server's proxy feature must be used. The Grafana server has support for token authentication (OAuth) and HTTP Header authentication. If the calls have to be sent directly from the browser to a third-party API then this will not be possible and sensitive data will not be encrypted. | |||
|
|||
Read more here about how [Authentication for Datasources]({{< relref "auth-for-datasources.md" >}}) works. | |||
Read more here about how [Authentication for Data Sources]({{< relref "auth-for-datasources.md" >}}) works. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably be:
about how [authentication for data sources](...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense!
docs/sources/reference/templating.md
Outdated
@@ -147,7 +147,7 @@ Type | Description | |||
------- | -------- | |||
*Query* | This variable type allows you to write a data source query that usually returns a list of metric names, tag values or keys. For example, a query that returns a list of server names, sensor ids or data centers. | |||
*Interval* | This variable can represent time spans. Instead of hard-coding a group by time or date histogram interval, use a variable of this type. | |||
*Datasource* | This type allows you to quickly change the data source for an entire Dashboard. Useful if you have multiple instances of a data source in for example different environments. | |||
*Data Source* | This type allows you to quickly change the data source for an entire Dashboard. Useful if you have multiple instances of a data source in for example different environments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lowercase S, I think
@@ -1,4 +1,4 @@ | |||
# Graphite Datasource - Native Plugin | |||
# Graphite Data Source - Native Plugin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the READMEs, let's keep Title Case for now. This is fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, noted.
Thanks for this! 👍 Actually, don't bother with the casing for now. We can do that in subsequent PRs. Let's leave this one as a search-and-replace. Only real issue is the YAML example should be corrected. |
@@ -31,7 +31,7 @@ The data source can access metrics from four different services. You can configu | |||
- [Guide to setting up an Azure Active Directory Application for Azure Log Analytics.](https://dev.loganalytics.io/documentation/Authorization/AAD-Setup) | |||
- [Quickstart Guide for Application Insights.](https://dev.applicationinsights.io/quickstart/) | |||
|
|||
1. Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section. Next, click the "Add data source" button in the upper right. The Azure Monitor data source will be available for selection in the Cloud section in the list of data sources. | |||
1. Accessed from the Grafana main menu, newly installed data sources can be added immediately within the data sources section. Next, click the "Add data source" button in the upper right. The Azure Monitor data source will be available for selection in the Cloud section in the list of data sources. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This refers to the section in the main menu, where it says "Data Sources", so we should leave this one as is.
@@ -10,11 +10,11 @@ parent = "permissions" | |||
weight = 4 | |||
+++ | |||
|
|||
# Data Source Permissions | |||
# Data Source Permissions API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page describes concept of data source permissions, and not the API (as opposed to docs/sources/http_api/datasource_permissions.md).
|
||
Time series response from datasource.query. | ||
Time series response from data source.query. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is referring to a code function, and should be left as is.
|
||
> Datasource Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). | ||
> The Data Source Permissions API is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same thing here.
|
||
Datasource permissions allows you to restrict access for users to query a datasource. For each datasource there is | ||
The Data Source Permissions API allows you to restrict access for users to query a data source. For each data source there is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... and here
Thanks a lot! This is a major improvement! 👍 |
Minor edits: