diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt index 29df243e23..311cc807fd 100644 --- a/.github/styles/vocab.txt +++ b/.github/styles/vocab.txt @@ -75,18 +75,15 @@ Firekube Fiverr freben Fredrik -github GitHub -gitlab GitLab Grafana -graphql +GraphQL graphviz Gustavsson Hackathons haproxy Henneke -heroku Heroku horizontalpodautoscalers Hostname @@ -98,8 +95,7 @@ incentivised inlined inlinehilite interop -javascript -Javascript +JavaScript jq js json @@ -142,10 +138,8 @@ noop npm nvarchar nvm -oauth OAuth oidc -okta Okta Oldsberg onboarding diff --git a/docs/features/software-catalog/configuration.md b/docs/features/software-catalog/configuration.md index d10fb29e30..d5ad240dde 100644 --- a/docs/features/software-catalog/configuration.md +++ b/docs/features/software-catalog/configuration.md @@ -60,7 +60,7 @@ data from. Each entry is a structure with up to four elements: and raw. If it is not supplied, anonymous access will be used. - `apiBaseUrl` (optional): If you want to communicate using the APIv3 method with this provider, specify the base URL for its endpoint here, with no - trailing slash. Specifically when the target is github, you can leave it out + trailing slash. Specifically when the target is GitHub, you can leave it out to be inferred automatically. For a GitHub Enterprise installation, it is commonly at `https://api.` or `https:///api/v3`. - `rawBaseUrl` (optional): If you want to communicate using the raw HTTP method diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md index c53193f063..26da074eb8 100644 --- a/docs/overview/stability-index.md +++ b/docs/overview/stability-index.md @@ -291,7 +291,7 @@ Stability: `1`. There are plans to rework parts of the Processor interface. ### `catalog-graphql` [GitHub](https://github.com/backstage/backstage/tree/master/plugins/catalog-graphql/) -Provides the catalog schema and resolvers for the graphql backend. +Provides the catalog schema and resolvers for the GraphQL backend. Stability: `0`. Under heavy development and subject to change. diff --git a/docs/plugins/publishing.md b/docs/plugins/publishing.md index efea02ee23..06fae0533e 100644 --- a/docs/plugins/publishing.md +++ b/docs/plugins/publishing.md @@ -7,7 +7,7 @@ description: Documentation on Publishing npm packages ## npm npm packages are published through CI/CD in the -[.github/workflows/master.yml](https://github.com/backstage/backstage/blob/master/.github/workflows/master.yml) +[`.github/workflows/master.yml`](https://github.com/backstage/backstage/blob/master/.github/workflows/master.yml) workflow. Every commit that is merged to master will be checked for new versions of all public packages, and any new versions will automatically be published to npm. diff --git a/docs/reference/utility-apis/ErrorApi.md b/docs/reference/utility-apis/ErrorApi.md index 93f4f9cd48..9bba0c76c6 100644 --- a/docs/reference/utility-apis/ErrorApi.md +++ b/docs/reference/utility-apis/ErrorApi.md @@ -29,7 +29,7 @@ These types are part of the API declaration, but may not be unique to this API. ### Error -Mirrors the javascript Error class, for the purpose of providing documentation +Mirrors the JavaScript Error class, for the purpose of providing documentation and optional fields.
diff --git a/docs/tutorials/quickstart-app-auth.md b/docs/tutorials/quickstart-app-auth.md
index 1dcca9d7e0..3cc62ec84e 100644
--- a/docs/tutorials/quickstart-app-auth.md
+++ b/docs/tutorials/quickstart-app-auth.md
@@ -107,7 +107,7 @@ export AUTH_GITHUB_CLIENT_SECRET=xxx
 > ...
 ```
 
-4. The values to replace `xxx` above come from your oauth app setup.
+4. The values to replace `xxx` above come from your OAuth app setup.
 
 ```
 > Log into http://github.com
diff --git a/docs/tutorials/quickstart-app-plugin.md b/docs/tutorials/quickstart-app-plugin.md
index 0f8d9bb84b..045062fdcb 100644
--- a/docs/tutorials/quickstart-app-plugin.md
+++ b/docs/tutorials/quickstart-app-plugin.md
@@ -59,7 +59,7 @@ import GitHubIcon from '@material-ui/icons/GitHub';
 ```
 
 Simple! The App will reload with your changes automatically. You should now see
-a github icon displayed in the sidebar. Clicking that will link to our new
+a GitHub icon displayed in the sidebar. Clicking that will link to our new
 plugin. And now, the API fun begins.
 
 # The Identity
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
index 8b503c6941..adf041b4bb 100644
--- a/packages/cli/CHANGELOG.md
+++ b/packages/cli/CHANGELOG.md
@@ -21,7 +21,7 @@
 
 ### Patch Changes
 
-- 19554f6d6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
+- 19554f6d6: Added GitHub Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
 - 7d72f9b09: Fix for `app.listen.host` configuration not properly overriding listening host.
 
 ## 0.4.2
diff --git a/packages/core-api/src/apis/definitions/ErrorApi.ts b/packages/core-api/src/apis/definitions/ErrorApi.ts
index dfa08130cd..6205f8e058 100644
--- a/packages/core-api/src/apis/definitions/ErrorApi.ts
+++ b/packages/core-api/src/apis/definitions/ErrorApi.ts
@@ -18,7 +18,7 @@ import { ApiRef, createApiRef } from '../system';
 import { Observable } from '../../types';
 
 /**
- * Mirrors the javascript Error class, for the purpose of
+ * Mirrors the JavaScript Error class, for the purpose of
  * providing documentation and optional fields.
  */
 type Error = {
diff --git a/plugins/auth-backend/README.md b/plugins/auth-backend/README.md
index 49d8d52fd3..1fea3346a7 100644
--- a/plugins/auth-backend/README.md
+++ b/plugins/auth-backend/README.md
@@ -10,7 +10,7 @@ to the appropriate provider in the backend.
 ## Local development
 
 Choose your OAuth Providers, replace `x` with actual value and then start backend:
-Example for Google Oauth Provider at root directory:
+Example for Google OAuth Provider at root directory:
 
 ```bash
 export AUTH_GOOGLE_CLIENT_ID=x
@@ -91,9 +91,9 @@ export AUTH_GITLAB_CLIENT_SECRET=x
 
 Add a new Okta application using the following URI conventions:
 
-Login redirect URI's: http://localhost:7000/api/auth/okta/handler/frame
-Logout redirect URI's: http://localhost:7000/api/auth/okta/logout
-Initiate login URI's: http://localhost:7000/api/auth/okta/start
+Login redirect URI's: `http://localhost:7000/api/auth/okta/handler/frame`
+Logout redirect URI's: `http://localhost:7000/api/auth/okta/logout`
+Initiate login URI's: `http://localhost:7000/api/auth/okta/start`
 
 Then configure the following environment variables to be used in the `app-config.yaml` file:
 
diff --git a/plugins/catalog-backend/CHANGELOG.md b/plugins/catalog-backend/CHANGELOG.md
index bef186f8c3..b60555037c 100644
--- a/plugins/catalog-backend/CHANGELOG.md
+++ b/plugins/catalog-backend/CHANGELOG.md
@@ -54,7 +54,7 @@
 
 ### Patch Changes
 
-- c6eeefa35: Add support for Github Enterprise in GitHubOrgReaderProcessor so you can properly ingest users of a GHE organization.
+- c6eeefa35: Add support for GitHub Enterprise in GitHubOrgReaderProcessor so you can properly ingest users of a GHE organization.
 - fb386b760: Break the refresh loop into several smaller transactions
 - 7c3ffc0cd: Support `profile` of groups including `displayName`, `email`, and `picture` in
   `LdapOrgReaderProcessor`. The source fields for them can be configured in the
diff --git a/plugins/github-actions/CHANGELOG.md b/plugins/github-actions/CHANGELOG.md
index 2d69b1499d..f2537742f4 100644
--- a/plugins/github-actions/CHANGELOG.md
+++ b/plugins/github-actions/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 ### Patch Changes
 
-- 19554f6d6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
+- 19554f6d6: Added GitHub Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
 - Updated dependencies [d681db2b5]
 - Updated dependencies [1dc445e89]
 - Updated dependencies [342270e4d]
@@ -94,7 +94,7 @@
 ### Minor Changes
 
 - 28edd7d29: Create backend plugin through CLI
-- d67c529ab: Adds a widget to show recent git workflow runs to the github actions plugin. The default setting is the last 5 runs across all branches but both branch and the number of runs are configurable.
+- d67c529ab: Adds a widget to show recent git workflow runs to the GitHub actions plugin. The default setting is the last 5 runs across all branches but both branch and the number of runs are configurable.
 - 6d97d2d6f: The InfoCard variant `'height100'` is deprecated. Use variant `'gridItem'` instead.
 
   When the InfoCard is displayed as a grid item within a grid, you may want items to have the same height for all items.
diff --git a/plugins/scaffolder-backend/CHANGELOG.md b/plugins/scaffolder-backend/CHANGELOG.md
index 2cf1048791..ee54a5c794 100644
--- a/plugins/scaffolder-backend/CHANGELOG.md
+++ b/plugins/scaffolder-backend/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 ### Minor Changes
 
-- 5eb8c9b9e: Fix gitlab scaffolder publisher
+- 5eb8c9b9e: Fix GitLab scaffolder publisher
 
 ### Patch Changes
 
@@ -28,7 +28,7 @@
 
 ### Patch Changes
 
-- 19554f6d6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
+- 19554f6d6: Added GitHub Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
 - 33a82a713: GitLab preparer uses the right token (primarily the same one as the publisher, falling back to the integrations token)
 - aed8f7f12: Clearer error message when preparer or publisher type can't be determined.
 
diff --git a/plugins/scaffolder/CHANGELOG.md b/plugins/scaffolder/CHANGELOG.md
index 41965cb687..dbbc1dda2e 100644
--- a/plugins/scaffolder/CHANGELOG.md
+++ b/plugins/scaffolder/CHANGELOG.md
@@ -13,7 +13,7 @@
 
 ### Patch Changes
 
-- 19554f6d6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
+- 19554f6d6: Added GitHub Actions for Create React App, and allow better imports of files inside a module when they're exposed using `files` in `package.json`
 - Updated dependencies [1dc445e89]
 - Updated dependencies [342270e4d]
   - @backstage/core@0.4.2