Docs: Minor edits to the README and several md files #19238

bharjala · 2019-09-19T18:23:17Z

Minor edits:

Update README: Capitalized the G and S in "Getting Started," and moved "guide" to match the section title in the docs.
Fixed sentence structure: Changed "download" to "grafana.com/get" and changed "get" to "download."
Docs: Replace "datasources" with "data sources."

Capitalized the G and S in "Getting Started," and moved "guide" to match the section title in the docs.

… changed "get" to "download".

CLAassistant · 2019-09-19T18:23:56Z

All committers have signed the CLA.

marcusolsson · 2019-09-19T18:36:55Z

README.md

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


Should the S be capitalized here?

marcusolsson · 2019-09-19T18:44:01Z

docs/sources/enterprise/_index.md

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


This should probably be in sentence case

marcusolsson · 2019-09-19T18:45:26Z

docs/sources/features/datasources/cloudwatch.md

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


This heading should also be sentence case

marcusolsson · 2019-09-19T18:50:17Z

docs/sources/features/datasources/cloudwatch.md


 Using a credentials file
 ```yaml
 apiVersion: 1

-datasources:
+data sources:


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.

Got it! Will not touch yaml examples.

marcusolsson · 2019-09-19T18:51:00Z

docs/sources/features/datasources/cloudwatch.md

@@ -274,7 +274,7 @@ Using `accessKey` and `secretKey`
 ```yaml
 apiVersion: 1

-datasources:
+data sources:


YAML again. This should not be changed.

marcusolsson · 2019-09-19T19:05:41Z

docs/sources/plugins/developing/datasources.md

@@ -8,17 +8,17 @@ parent = "developing"
 weight = 5
 +++

-# Datasources
+# Data Sources


Sentence case

marcusolsson · 2019-09-19T19:05:57Z

docs/sources/plugins/developing/datasources.md

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


Sentence case

marcusolsson · 2019-09-19T19:07:39Z

docs/sources/plugins/developing/plugin-review-guidelines.md

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


This should probably be:

about how [authentication for data sources](...

Makes sense!

marcusolsson · 2019-09-19T19:08:35Z

docs/sources/reference/templating.md

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


Lowercase S, I think

marcusolsson · 2019-09-19T19:09:44Z

public/app/plugins/datasource/graphite/README.md

@@ -1,4 +1,4 @@
-# Graphite Datasource -  Native Plugin
+# Graphite Data Source -  Native Plugin


For the READMEs, let's keep Title Case for now. This is fine.

Thanks, noted.

marcusolsson · 2019-09-19T19:17:31Z

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.

marcusolsson · 2019-09-19T21:26:50Z

docs/sources/features/datasources/azuremonitor.md

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


This refers to the section in the main menu, where it says "Data Sources", so we should leave this one as is.

marcusolsson · 2019-09-19T21:28:07Z

docs/sources/permissions/datasource_permissions.md

@@ -10,11 +10,11 @@ parent = "permissions"
 weight = 4
 +++

-# Data Source Permissions
+# Data Source Permissions API


This page describes concept of data source permissions, and not the API (as opposed to docs/sources/http_api/datasource_permissions.md).

marcusolsson · 2019-09-19T21:38:11Z

docs/sources/plugins/developing/datasources.md


-Time series response from datasource.query.
+Time series response from data source.query.


This is referring to a code function, and should be left as is.

marcusolsson · 2019-09-19T21:41:35Z

docs/sources/permissions/datasource_permissions.md


-> 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" >}}).


Same thing here.

marcusolsson · 2019-09-19T21:41:46Z

docs/sources/permissions/datasource_permissions.md


-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


... and here

marcusolsson · 2019-09-19T22:05:03Z

Thanks a lot! This is a major improvement! 👍

bharjala and others added 10 commits September 12, 2019 13:47

Update README.md

117596b

Capitalized the G and S in "Getting Started," and moved "guide" to match the section title in the docs.

Fixed sentence structure. Changed "download" to "grafana.com/get" and…

0e3ef48

… changed "get" to "download".

Docs: Replace "datasources" with "data sources" (#19111)

dfe9878

Docs: Replace "datasources" with "data sources" (#19111)

208fb43

Docs: Replace "datasources" with "data sources" (#19111)

b89ab22

Docs: Replace "datasources" with "data sources" (#19111)

81432dd

Docs: Replace "datasources" with "data sources" (#19111)

28505c1

Docs: Replace "datasources" with "data sources" (#19111)

aae9937

Docs: Replace "datasources" with "data sources" (#19111)

ea5b4e7

Docs: Replace "datasources" with "data sources" (#19111)

bd2861e

marcusolsson suggested changes Sep 19, 2019

View reviewed changes

Docs: Replace "datasources" with "data sources" (#19111)

717156a

marcusolsson reviewed Sep 19, 2019

View reviewed changes

Docs: Replace "datasources" with "data sources" (#19111)

3f8b6a7

marcusolsson reviewed Sep 19, 2019

View reviewed changes

Docs: Replace "datasources" with "data sources" (#19111)

e087d40

marcusolsson reviewed Sep 19, 2019

View reviewed changes

Docs: Replace "datasources" with "data sources" (#19111)

04f55e5

marcusolsson approved these changes Sep 19, 2019

View reviewed changes

marcusolsson merged commit c9e566b into grafana:master Sep 19, 2019

This was referenced Sep 19, 2019

Fix docs issues #19240

Merged

Change datasource to data source in documentation #19111

Closed

ying-jeanne added the pr/external This PR is from external contributor label Apr 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Minor edits to the README and several md files #19238

Docs: Minor edits to the README and several md files #19238

bharjala commented Sep 19, 2019

CLAassistant commented Sep 19, 2019 •

edited

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

bharjala Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

bharjala Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

bharjala Sep 19, 2019

marcusolsson commented Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson Sep 19, 2019

marcusolsson commented Sep 19, 2019

		@@ -1,4 +1,4 @@
		# Graphite Datasource - Native Plugin
		# Graphite Data Source - Native Plugin


		Time series response from datasource.query.
		Time series response from data source.query.


		> 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" >}}).


		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

Docs: Minor edits to the README and several md files #19238

Docs: Minor edits to the README and several md files #19238

Conversation

bharjala commented Sep 19, 2019

CLAassistant commented Sep 19, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcusolsson commented Sep 19, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcusolsson commented Sep 19, 2019

CLAassistant commented Sep 19, 2019 •

edited