From 7d08a8497a62dcf38b237c863ff9231968e042e4 Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Wed, 22 Jul 2020 11:12:50 -0400 Subject: [PATCH] Chore: fix spelling of GitHub (#26182) Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> --- CHANGELOG.md | 16 ++++++++-------- ISSUE_TRIAGE.md | 8 ++++---- conf/defaults.ini | 2 +- conf/sample.ini | 2 +- .../style-guides/documentation-markdown-guide.md | 6 +++--- .../src/cli/tasks/plugin.create.ts | 2 +- .../src/cli/tasks/plugin.utils.ts | 4 ++-- .../src/cli/utils/githubClient.ts | 2 +- pkg/login/social/social.go | 2 +- .../prometheus/dashboards/prometheus_stats.json | 2 +- .../plugins/datasource/testdata/TestInfoTab.tsx | 2 +- 11 files changed, 24 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index efc71533f47..1a6db78aa0a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2033,7 +2033,7 @@ See [security announcement](https://community.grafana.com/t/grafana-5-3-3-and-4- - **Docker**: Make it possible to set a specific plugin url [#12861](https://github.com/grafana/grafana/pull/12861), thx [ClementGautier](https://github.com/ClementGautier) - **GrafanaCli**: Fixed issue with grafana-cli install plugin resulting in corrupt http response from source error. Fixes [#13079](https://github.com/grafana/grafana/issues/13079) - **Provisioning**: Should allow one default data source per organization [#12229](https://github.com/grafana/grafana/issues/12229) -- **Github OAuth**: Allow changes of user info at Github to be synched to Grafana when signing in [#11818](https://github.com/grafana/grafana/issues/11818), thx [@rwaweber](https://github.com/rwaweber) +- **GitHub OAuth**: Allow changes of user info at GitHub to be synched to Grafana when signing in [#11818](https://github.com/grafana/grafana/issues/11818), thx [@rwaweber](https://github.com/rwaweber) - **OAuth**: Fix overriding tls_skip_verify_insecure using environment variable [#12747](https://github.com/grafana/grafana/issues/12747), thx [@jangaraj](https://github.com/jangaraj) - **Prometheus**: Fix graph panel bar width issue in aligned prometheus queries [#12379](https://github.com/grafana/grafana/issues/12379) - **Prometheus**: Heatmap - fix unhandled error when some points are missing [#12484](https://github.com/grafana/grafana/issues/12484) @@ -2348,7 +2348,7 @@ See [security announcement](https://community.grafana.com/t/grafana-5-2-3-and-4- ### Fixes -- **oauth** Fix Github OAuth not working with private Organizations [#11028](https://github.com/grafana/grafana/pull/11028) [@lostick](https://github.com/lostick) +- **oauth** Fix GitHub OAuth not working with private Organizations [#11028](https://github.com/grafana/grafana/pull/11028) [@lostick](https://github.com/lostick) - **kiosk** white area over bottom panels in kiosk mode [#11010](https://github.com/grafana/grafana/issues/11010) - **alerting** Fix OK state doesn't show up in Microsoft Teams [#11032](https://github.com/grafana/grafana/pull/11032), thx [@manacker](https://github.com/manacker) @@ -2360,7 +2360,7 @@ See [security announcement](https://community.grafana.com/t/grafana-5-2-3-and-4- - **Folders** Make it easier/explicit to access/modify folders using the API [#10630](https://github.com/grafana/grafana/issues/10630) - **Dashboard** Scrollbar works incorrectly in Grafana 5.0 Beta4 in some cases [#10982](https://github.com/grafana/grafana/issues/10982) - **ElasticSearch** Custom aggregation sizes no longer allowed for Elasticsearch [#10124](https://github.com/grafana/grafana/issues/10124) -- **oauth** Github OAuth with allowed organizations fails to login [#10964](https://github.com/grafana/grafana/issues/10964) +- **oauth** GitHub OAuth with allowed organizations fails to login [#10964](https://github.com/grafana/grafana/issues/10964) - **heatmap** Heatmap panel has partially hidden legend [#10793](https://github.com/grafana/grafana/issues/10793) - **snapshots** Expired snapshots not being cleaned up [#10996](https://github.com/grafana/grafana/pull/10996) @@ -2393,7 +2393,7 @@ See [security announcement](https://community.grafana.com/t/grafana-5-2-3-and-4- - **Light theme** Fixed problem with light theme in safari, [#10869](https://github.com/grafana/grafana/issues/10869) - **Provisioning** Now handles deletes when dashboard json files removed from disk [#10865](https://github.com/grafana/grafana/issues/10865) - **MySQL** Fixed issue with schema migration on old mysql (index too long) [#10779](https://github.com/grafana/grafana/issues/10779) -- **Github OAuth** Fixed fetching github orgs from private github org [#10823](https://github.com/grafana/grafana/issues/10823) +- **GitHub OAuth** Fixed fetching github orgs from private github org [#10823](https://github.com/grafana/grafana/issues/10823) - **Embedding** Fixed issues embedding panel [#10787](https://github.com/grafana/grafana/issues/10787) # 5.0.0-beta1 (2018-02-05) @@ -2452,7 +2452,7 @@ Dashboard panels and rows are positioned using a gridPos object `{x: 0, y: 0, w: - **Dashboard**: Make it possible to start dashboards from search and dashboard list panel [#1871](https://github.com/grafana/grafana/issues/1871) - **Annotations**: Posting annotations now return the id of the annotation [#9798](https://github.com/grafana/grafana/issues/9798) - **Systemd**: Use systemd notification ready flag [#10024](https://github.com/grafana/grafana/issues/10024), thx [@jgrassler](https://github.com/jgrassler) -- **Github**: Use organizations_url provided from github to verify user belongs in org. [#10111](https://github.com/grafana/grafana/issues/10111), thx +- **GitHub**: Use organizations_url provided from github to verify user belongs in org. [#10111](https://github.com/grafana/grafana/issues/10111), thx [@adiletmaratov](https://github.com/adiletmaratov) - **Backend**: Fixed bug where Grafana exited before all sub routines where finished [#10131](https://github.com/grafana/grafana/issues/10131) - **Azure**: Adds support for Azure blob storage as external image stor [#8955](https://github.com/grafana/grafana/issues/8955), thx [@saada](https://github.com/saada) @@ -3459,8 +3459,8 @@ Grunt & Watch tasks: - [Issue #2218](https://github.com/grafana/grafana/issues/2218). Auth: You can now authenticate against api with username / password using basic auth - [Issue #2095](https://github.com/grafana/grafana/issues/2095). Search: Search now supports filtering by multiple dashboard tags -- [Issue #1905](https://github.com/grafana/grafana/issues/1905). Github OAuth: You can now configure a Github team membership requirement, thx @dewski -- [Issue #2052](https://github.com/grafana/grafana/issues/2052). Github OAuth: You can now configure a Github organization requirement, thx @indrekj +- [Issue #1905](https://github.com/grafana/grafana/issues/1905). GitHub OAuth: You can now configure a GitHub team membership requirement, thx @dewski +- [Issue #2052](https://github.com/grafana/grafana/issues/2052). GitHub OAuth: You can now configure a GitHub organization requirement, thx @indrekj - [Issue #1891](https://github.com/grafana/grafana/issues/1891). Security: New config option to disable the use of gravatar for profile images - [Issue #1921](https://github.com/grafana/grafana/issues/1921). Auth: Support for user authentication via reverse proxy header (like X-Authenticated-User, or X-WEBAUTH-USER) - [Issue #960](https://github.com/grafana/grafana/issues/960). Search: Backend can now index a folder with json files, will be available in search (saving back to folder is not supported, this feature is meant for static generated json dashboards) @@ -3502,7 +3502,7 @@ Grunt & Watch tasks: - [Issue #1749](https://github.com/grafana/grafana/issues/1749). Graph Panel: Table legends are now visible when rendered to PNG - [Issue #1786](https://github.com/grafana/grafana/issues/1786). Graph Panel: Legend in table mode now aligns, graph area is reduced depending on how many series - [Issue #1734](https://github.com/grafana/grafana/issues/1734). Support for unicode / international characters in dashboard title (improved slugify) -- [Issue #1782](https://github.com/grafana/grafana/issues/1782). Github OAuth: Now works with Github for Enterprise, thanks @williamjoy +- [Issue #1782](https://github.com/grafana/grafana/issues/1782). GitHub OAuth: Now works with GitHub for Enterprise, thanks @williamjoy - [Issue #1780](https://github.com/grafana/grafana/issues/1780). Dashboard snapshot: Should not require login to view snapshot, Fixes #1780 # 2.0.0-Beta3 (2015-04-12) diff --git a/ISSUE_TRIAGE.md b/ISSUE_TRIAGE.md index 39db8fa925f..9546f8c7f8a 100644 --- a/ISSUE_TRIAGE.md +++ b/ISSUE_TRIAGE.md @@ -327,14 +327,14 @@ This will give you a structure of labels in the sidebar similar to the following ``` - Inbox ... - - Github (mine) + - GitHub (mine) - activity - assigned - mentions - - Github (other) + - GitHub (other) - Grafana ``` -* All notifications you’ll need to read/take action on show up as unread in Github (mine) and its sub-labels. -* All other notifications you don’t need to take action on show up as unread in Github (other) and its sub-labels +* All notifications you’ll need to read/take action on show up as unread in GitHub (mine) and its sub-labels. +* All other notifications you don’t need to take action on show up as unread in GitHub (other) and its sub-labels * This is convenient for issue triage and to follow the activity in the Grafana project. diff --git a/conf/defaults.ini b/conf/defaults.ini index 72b598b1df7..b02ece6da16 100644 --- a/conf/defaults.ini +++ b/conf/defaults.ini @@ -321,7 +321,7 @@ org_role = Viewer # mask the Grafana version number for unauthenticated users hide_version = false -#################################### Github Auth ######################### +#################################### GitHub Auth ######################### [auth.github] enabled = false allow_sign_up = true diff --git a/conf/sample.ini b/conf/sample.ini index 3b51f10414f..15f18e3ab77 100644 --- a/conf/sample.ini +++ b/conf/sample.ini @@ -320,7 +320,7 @@ # mask the Grafana version number for unauthenticated users ;hide_version = false -#################################### Github Auth ########################## +#################################### GitHub Auth ########################## [auth.github] ;enabled = false ;allow_sign_up = true diff --git a/contribute/style-guides/documentation-markdown-guide.md b/contribute/style-guides/documentation-markdown-guide.md index 77e619621ec..d031fb76348 100644 --- a/contribute/style-guides/documentation-markdown-guide.md +++ b/contribute/style-guides/documentation-markdown-guide.md @@ -22,11 +22,11 @@ Start your document with a single ``#`` for the title of the page. Add the sub-h * Make text **bold** using two asterisks. -**Example:** It is ``**important**`` to use Github Flavored Markdown emoji consistently. +**Example:** It is ``**important**`` to use GitHub Flavored Markdown emoji consistently. * Make text ``*emphasized*`` using single `` _underscores_`` or a single asterisk. -**Example:** Github Flavored Markdown emoji should _only_ appear in specific cases. +**Example:** GitHub Flavored Markdown emoji should _only_ appear in specific cases. ## Links and references @@ -36,7 +36,7 @@ the web URL in curved brackets. \[text to display](www.website.com) -**Example:** For more information on including emoji in Github flavored Markdown, refer to the [webfx page on emoji](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of emoji. +**Example:** For more information on including emoji in GitHub flavored Markdown, refer to the [webfx page on emoji](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of emoji. ## Block quotes diff --git a/packages/grafana-toolkit/src/cli/tasks/plugin.create.ts b/packages/grafana-toolkit/src/cli/tasks/plugin.create.ts index e5bf8286734..0eb2647686a 100644 --- a/packages/grafana-toolkit/src/cli/tasks/plugin.create.ts +++ b/packages/grafana-toolkit/src/cli/tasks/plugin.create.ts @@ -28,7 +28,7 @@ const pluginCreateRunner: TaskRunner = async ({ name }) => // 2. Prompt plugin template const { type } = await promptPluginType(); - // 3. Fetch plugin template from Github + // 3. Fetch plugin template from GitHub await fetchTemplate({ type, dest: destPath }); // 4. Prompt plugin details diff --git a/packages/grafana-toolkit/src/cli/tasks/plugin.utils.ts b/packages/grafana-toolkit/src/cli/tasks/plugin.utils.ts index 6222ccd49d0..c74bfc7077a 100755 --- a/packages/grafana-toolkit/src/cli/tasks/plugin.utils.ts +++ b/packages/grafana-toolkit/src/cli/tasks/plugin.utils.ts @@ -181,7 +181,7 @@ const githubPublishRunner: TaskRunner = async ({ dryrun, v process.env['GITHUB_ACCESS_TOKEN'] = process.env['GITHUB_TOKEN']; } else { throw new Error( - `Github publish requires that you set the environment variable GITHUB_ACCESS_TOKEN to a valid github api token. + `GitHub publish requires that you set the environment variable GITHUB_ACCESS_TOKEN to a valid github api token. See: https://github.com/settings/tokens for more details.` ); } @@ -209,4 +209,4 @@ const githubPublishRunner: TaskRunner = async ({ dryrun, v }); }; -export const githubPublishTask = new Task('Github Publish', githubPublishRunner); +export const githubPublishTask = new Task('GitHub Publish', githubPublishRunner); diff --git a/packages/grafana-toolkit/src/cli/utils/githubClient.ts b/packages/grafana-toolkit/src/cli/utils/githubClient.ts index 87cbf9f54ca..05a1ff21f29 100644 --- a/packages/grafana-toolkit/src/cli/utils/githubClient.ts +++ b/packages/grafana-toolkit/src/cli/utils/githubClient.ts @@ -3,7 +3,7 @@ import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'; const grafanaURL = (owner: string, repo: string) => `https://api.github.com/repos/${owner}/${repo}`; const enterpriseURL = 'https://api.github.com/repos/grafana/grafana-enterprise'; -// Encapsulates the creation of a client for the Github API +// Encapsulates the creation of a client for the GitHub API // // Two key things: // 1. You can specify whenever you want the credentials to be required or not when imported. diff --git a/pkg/login/social/social.go b/pkg/login/social/social.go index aa65d9e0240..fc4b9c9141e 100644 --- a/pkg/login/social/social.go +++ b/pkg/login/social/social.go @@ -166,7 +166,7 @@ func NewOAuthService() { } } - // Generic - Uses the same scheme as Github. + // Generic - Uses the same scheme as GitHub. if name == "generic_oauth" { SocialMap["generic_oauth"] = &SocialGenericOAuth{ SocialBase: newSocialBase(name, &config, info), diff --git a/public/app/plugins/datasource/prometheus/dashboards/prometheus_stats.json b/public/app/plugins/datasource/prometheus/dashboards/prometheus_stats.json index ac603ea4627..14824fedfdf 100644 --- a/public/app/plugins/datasource/prometheus/dashboards/prometheus_stats.json +++ b/public/app/plugins/datasource/prometheus/dashboards/prometheus_stats.json @@ -357,7 +357,7 @@ } }, { - "content": "#### Samples Ingested\nThis graph displays the count of samples ingested by the Prometheus server, as measured over the last 5 minutes, per time series in the range vector. When troubleshooting an issue on IRC or Github, this is often the first stat requested by the Prometheus team. ", + "content": "#### Samples Ingested\nThis graph displays the count of samples ingested by the Prometheus server, as measured over the last 5 minutes, per time series in the range vector. When troubleshooting an issue on IRC or GitHub, this is often the first stat requested by the Prometheus team. ", "datasource": null, "editable": true, "error": false, diff --git a/public/app/plugins/datasource/testdata/TestInfoTab.tsx b/public/app/plugins/datasource/testdata/TestInfoTab.tsx index 9ed37c91ea9..3136292eac5 100644 --- a/public/app/plugins/datasource/testdata/TestInfoTab.tsx +++ b/public/app/plugins/datasource/testdata/TestInfoTab.tsx @@ -23,7 +23,7 @@ export class TestInfoTab extends PureComponent { target="_blank" rel="noopener" > - Github + GitHub