Skip to content

Commit

Permalink
Fix typos (backstage#3646)
Browse files Browse the repository at this point in the history
  • Loading branch information
friederbluemle authored Dec 9, 2020
1 parent 1c69d47 commit cbd3a44
Show file tree
Hide file tree
Showing 41 changed files with 58 additions and 58 deletions.
4 changes: 2 additions & 2 deletions .github/styles/vocab.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ Firekube
freben
Fredrik
github
Github
GitHub
gitlab
Gitlab
GitLab
Grafana
graphql
graphviz
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:
- name: prepare nightly release
run: yarn changeset version --snapshot nightly

# Publishes the nightly release to NPM, by using tag we make sure the release is
# Publishes the nightly release to npm, by using tag we make sure the release is
# not flagged as the latest release, which means that people will not get this
# version of the package unless requested explicitly
- name: publish nightly release
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/techdocs-project-board.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Automatically add new TechDocs Issues and PRs to the GitHub project board
# Development of TechDocs in Backstage is managed by this Kanban board - https://github.com/orgs/backstage/projects/1
# New issues and PRs with TechDocs in their title or docs-like-code label will be added to the board.
# Caveat: New PRs created from forks will not be added since GitHub actions don't share credentials with forks.
# Caveat: New PRs created from forks will not be added since GitHub Actions don't share credentials with forks.

on:
issues:
Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ service. The `@backstage/create-app` tool that is used to create your own
Backstage app is similar to
[`create-react-app`](https://github.com/facebook/create-react-app) in that it
gives you a starting point. The code you get is meant to be evolved, and most of
the functionality you get out of the box is brought in via NPM dependencies.
the functionality you get out of the box is brought in via npm dependencies.
Keeping your app up to date generally means keeping your dependencies up to
date. The Backstage CLI provides a command to help you with that. Simply run
`yarn backstage-cli versions:bump` at the root of your repo, and the latest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ discover existing functionality in the ecosystem.
APIs are implemented by components and make their boundaries explicit. They
might be defined using an RPC IDL (e.g. in Protobuf, GraphQL or similar), a data
schema (e.g. in Avro, TFRecord or similar), or as code interfaces (e.g.
framework APIs in Swift, Kotlin, Java, C++, Typescript etc). In any case, APIs
framework APIs in Swift, Kotlin, Java, C++, TypeScript etc). In any case, APIs
exposed by components need to be in a known machine-readable format so we can
build further tooling and analysis on top.
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture-decisions/adr006-avoid-react-fc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Architecture Decision Record (ADR) log on Avoid React.FC and React.

## Context

Facebook has removed `React.FC` from their base template for a Typescript
Facebook has removed `React.FC` from their base template for a TypeScript
project. The reason for this was that it was found to be an unnecessary feature
with next to no benefits in combination with a few downsides.

Expand Down
4 changes: 2 additions & 2 deletions docs/features/software-catalog/descriptor-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ The current set of well-known and common values for this field is:

- `service` - a backend service, typically exposing an API
- `website` - a website
- `library` - a software library, such as an NPM module or a Java library
- `library` - a software library, such as an npm module or a Java library

### `spec.lifecycle` [required]

Expand Down Expand Up @@ -558,7 +558,7 @@ The current set of well-known and common values for this field is:

- `service` - a backend service, typically exposing an API
- `website` - a website
- `library` - a software library, such as an NPM module or a Java library
- `library` - a software library, such as an npm module or a Java library

### `spec.templater` [required]

Expand Down
4 changes: 2 additions & 2 deletions docs/features/techdocs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ looking at. In response, it receives the static files (HTML, CSS, JSON, etc.) to
render on the page in TechDocs/Backstage.

The static files consist of HTML, CSS and Images generated by MkDocs. We remove
all the Javascript before adding them to Backstage for security reasons. And
all the JavaScript before adding them to Backstage for security reasons. And
there are some additional techdocs metadata JSON files that TechDocs needs to
render a site.

Expand Down Expand Up @@ -59,7 +59,7 @@ Similar to how it is done in the Basic setup, the TechDocs Reader requests
your configured storage solution for the necessary files and returns them to
TechDocs Reader.

We will provide instructions, scripts and/or templates (e.g. GitHub actions) to
We will provide instructions, scripts and/or templates (e.g. GitHub Actions) to
build docs in your CI/CD system.
[Track progress here.](https://github.com/backstage/backstage/issues/3400) You
will be able to use `techdocs-cli` to build docs and publish the generated docs
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/configure-app-with-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ add an existing plugin to it. We are using the
[CircleCI](https://github.com/backstage/backstage/blob/master/plugins/circleci/README.md)
plugin in this example.

1. Add the plugin's NPM package to the repo:
1. Add the plugin's npm package to the repo:

```bash
yarn add @backstage/plugin-circleci
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/create-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ You may encounter the following error message:
Couldn't find any versions for "file-saver" that matches "eligrey-FileSaver.js-1.3.8.tar.gz-art-external"
```

This is likely because you have a globally configured NPM proxy, which breaks
This is likely because you have a globally configured npm proxy, which breaks
the installation of the `material-table` dependency. This is a known issue and
being worked on in `material-table`, but for now you can work around it using
the following:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ you're planning to do.

Creating a standalone instance makes it simpler to customize the application for
your needs whilst staying up to date with the project. You will also depend on
`@backstage` packages from NPM, making the project much smaller. This is the
`@backstage` packages from npm, making the project much smaller. This is the
recommended approach if you want to kick the tyres of Backstage or setup your
own instance.

Expand Down
8 changes: 4 additions & 4 deletions docs/plugins/publishing.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
id: publishing
title: Publishing
description: Documentation on Publishing NPM packages
description: Documentation on Publishing npm packages
---

## NPM
## npm

NPM packages are published through CI/CD in the
npm packages are published through CI/CD in the
[.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.
npm.

### Creating a new release

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ This is especially true for edge cases!

## Non-React Classes

Testing a Javascript object which is _not_ a React component follows a lot of
Testing a JavaScript object which is _not_ a React component follows a lot of
the same principles as testing objects in other languages.

### API Testing Principles
Expand All @@ -243,7 +243,7 @@ Testing an API involves verifying four things:

1. Invalid inputs are caught before being sent to the server.
2. Valid inputs translate into a valid browser request.
3. Server response is translated into an expected Javascript object.
3. Server response is translated into an expected JavaScript object.
4. Server errors are handled gracefully.

### Mocking API Calls
Expand Down
2 changes: 1 addition & 1 deletion docs/support/project-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ are separated out into their own folder, see further down.

- [`docgen/`](https://github.com/backstage/backstage/tree/master/packages/docgen) -
Uses the
[Typescript Compiler API](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API)
[TypeScript Compiler API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API)
to read out definitions and generate documentation for it.

- [`e2e-test/`](https://github.com/backstage/backstage/tree/master/packages/e2e-test) -
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/journey.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ music and wants to have a theme tune for every service in Backstage.

Sam built a Spotify plugin for Backstage that allows service owners to define a
theme tune for their service. The theme tune plays whenever a user visits the
service page in Backstage. The plugin is published to NPM and available for any
service page in Backstage. The plugin is published to npm and available for any
organization to easily install and add to their Backstage installation.

# 1. A New Plugin
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ nav:
- Testing:
- Overview: 'plugins/testing.md'
- Publishing:
- Open source and NPM: 'plugins/publishing.md'
- Open source and npm: 'plugins/publishing.md'
- Private/internal (non-open source): 'plugins/publish-private.md'
- Configuration:
- Overview: 'conf/index.md'
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This package provides a CLI for developing Backstage plugins and apps.

## Installation

Install the package via npm or yarn:
Install the package via npm or Yarn:

```sh
$ npm install --save @backstage/cli
Expand Down
6 changes: 3 additions & 3 deletions packages/cli/src/commands/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ export function registerCommands(program: CommanderStatic) {
'Create plugin with the backend dependencies as default',
)
.description('Creates a new plugin in the current repository')
.option('--scope <scope>', 'NPM scope')
.option('--npm-registry <URL>', 'NPM registry URL')
.option('--no-private', 'Public NPM Package')
.option('--scope <scope>', 'npm scope')
.option('--npm-registry <URL>', 'npm registry URL')
.option('--no-private', 'Public npm package')
.action(
lazy(() => import('./create-plugin/createPlugin').then(m => m.default)),
);
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/lib/packager/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ type Options = {
* will be suitable for packaging e.g. into a docker image.
*
* This creates a structure that is functionally similar to if the packages where
* installed from NPM, but uses yarn workspaces to link to them at runtime.
* installed from npm, but uses Yarn workspaces to link to them at runtime.
*/
export async function createDistWorkspace(
packageNames: string[],
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/lib/versioning/Lockfile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type LockfileQueryEntry = {
version: string;
};

/** Entries that have an invalid version range, for example an NPM tag */
/** Entries that have an invalid version range, for example an npm tag */
type AnalyzeResultInvalidRange = {
name: string;
range: string;
Expand Down
2 changes: 1 addition & 1 deletion packages/core-api/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@

![](https://user-images.githubusercontent.com/872486/93851658-1a76f200-fce3-11ea-990b-26ca1a327a15.png)

- b79017fd3: Updated the `GithubAuth.create` method to configure the default scope of the Github Auth Api. As a result the
- b79017fd3: Updated the `GithubAuth.create` method to configure the default scope of the GitHub Auth Api. As a result the
default scope is configurable when overwriting the Core Api in the app.

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export type GithubAuthResponse = {

const DEFAULT_PROVIDER = {
id: 'github',
title: 'Github',
title: 'GitHub',
icon: GithubIcon,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { OAuthApiCreateOptions } from '../types';

const DEFAULT_PROVIDER = {
id: 'gitlab',
title: 'Gitlab',
title: 'GitLab',
icon: GitlabIcon,
};

Expand Down
4 changes: 2 additions & 2 deletions packages/core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
### Patch Changes

- 7b37d65fd: Adds the MarkdownContent component to render and display Markdown content with the default
[GFM](https://github.github.com/gfm/) (Github flavored Markdown) dialect.
[GFM](https://github.github.com/gfm/) (GitHub Flavored Markdown) dialect.

```
<MarkdownContent content={markdownGithubFlavored} />
Expand Down Expand Up @@ -59,7 +59,7 @@

- 482b6313d: Fix dense in Structured Metadata Table
- 1c60f716e: Added EmptyState component
- b79017fd3: Updated the `GithubAuth.create` method to configure the default scope of the Github Auth Api. As a result the
- b79017fd3: Updated the `GithubAuth.create` method to configure the default scope of the GitHub Auth Api. As a result the
default scope is configurable when overwriting the Core Api in the app.

```
Expand Down
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This package provides the core API used by Backstage plugins and apps.

## Installation

Install the package via npm or yarn:
Install the package via npm or Yarn:

```sh
$ npm install --save @backstage/core
Expand Down
2 changes: 1 addition & 1 deletion packages/create-app/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@
--config ../../app-config.yaml --config ../../app-config.development.yaml
```

- 5a920c6e4: Updated naming of environment variables. New pattern [NAME]\_TOKEN for Github, Gitlab, Azure & Github enterprise access tokens.
- 5a920c6e4: Updated naming of environment variables. New pattern [NAME]\_TOKEN for GitHub, GitLab, Azure & GitHub Enterprise access tokens.

### Detail:

Expand Down
2 changes: 1 addition & 1 deletion packages/dev-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This package provides utilities that help in developing plugins for Backstage, l

## Installation

Install the package via npm or yarn:
Install the package via npm or Yarn:

```sh
$ npm install --save-dev @backstage/dev-utils
Expand Down
2 changes: 1 addition & 1 deletion packages/docgen/src/docgen/GitHubMarkdownPrinter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const COMMIT_SHA =
execSync('git rev-parse HEAD').toString('utf8').trim();

/**
* The GithubMarkdownPrinter is a MarkdownPrinter for printing Github-flavored markdown documents.
* The GithubMarkdownPrinter is a MarkdownPrinter for printing GitHub Flavored Markdown documents.
*/
export default class GithubMarkdownPrinter implements MarkdownPrinter {
private str: string = '';
Expand Down
2 changes: 1 addition & 1 deletion packages/docgen/src/docgen/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export type TypeLink = {
};

/**
* TypeInfo describes a Typescript Type.
* TypeInfo describes a TypeScript Type.
*/
export type TypeInfo = {
id: number;
Expand Down
2 changes: 1 addition & 1 deletion packages/integration/src/gitlab/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export async function getProjectId(
const url = new URL(target);

if (!url.pathname.includes('/-/blob/')) {
throw new Error('Please provide full path to yaml file from Gitlab');
throw new Error('Please provide full path to yaml file from GitLab');
}

try {
Expand Down
2 changes: 1 addition & 1 deletion packages/test-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This package provides utilities that can be used to test plugins and apps for Ba

## Installation

Install the package via npm or yarn:
Install the package via npm or Yarn:

```sh
$ npm install --save-dev @backstage/test-utils
Expand Down
2 changes: 1 addition & 1 deletion packages/theme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This package provides the extended Material UI Theme(s) that power Backstage.

## Installation

Install the package via npm or yarn:
Install the package via npm or Yarn:

```sh
$ npm install --save @backstage/theme
Expand Down
8 changes: 4 additions & 4 deletions plugins/auth-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export AUTH_GOOGLE_CLIENT_ID=x
export AUTH_GOOGLE_CLIENT_SECRET=x
```

### Github
### GitHub

#### Creating a GitHub OAuth application

Expand All @@ -42,15 +42,15 @@ export AUTH_GITHUB_CLIENT_ID=x
export AUTH_GITHUB_CLIENT_SECRET=x
```

for github enterprise:
For GitHub Enterprise:

```bash
export AUTH_GITHUB_CLIENT_ID=x
export AUTH_GITHUB_CLIENT_SECRET=x
export AUTH_GITHUB_ENTERPRISE_INSTANCE_URL=https://x
```

### Gitlab
### GitLab

#### Creating a GitLab OAuth application

Expand All @@ -70,7 +70,7 @@ Follow this link, [Add new application](https://gitlab.com/-/profile/application

```bash
export GITLAB_BASE_URL=https://gitlab.com
export AUTH_GITLAB_CLIENT_ID=x # Gitlab calls this the Application ID
export AUTH_GITLAB_CLIENT_ID=x # GitLab calls this the Application ID
export AUTH_GITLAB_CLIENT_SECRET=x
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export const RecentWorkflowRunsCard = ({
<EmptyState
missing="data"
title="No Workflow Data"
description="This component has Github Actions enabled, but no data was found. Have you created any Workflows? Click the button below to create a new Workflow."
description="This component has GitHub Actions enabled, but no data was found. Have you created any Workflows? Click the button below to create a new Workflow."
action={
<Button
variant="contained"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ export const WorkflowRunsTable = ({
<EmptyState
missing="data"
title="No Workflow Data"
description="This component has Github Actions enabled, but no data was found. Have you created any Workflows? Click the button below to create a new Workflow."
description="This component has GitHub Actions enabled, but no data was found. Have you created any Workflows? Click the button below to create a new Workflow."
action={
<Button
variant="contained"
Expand Down
Loading

0 comments on commit cbd3a44

Please sign in to comment.