Fix typos

Signed-off-by: Dimitris Apostolou <dimitris.apostolou@icloud.com>
2022-03-13 14:09:19 +02:00
parent b17dd0584d
commit aedd4daa66
54 changed files with 62 additions and 62 deletions
@@ -71,7 +71,7 @@ _If you're using Backstage in your organization, please try to add your company
 | [Signal Iduna Group](https://www.signal-iduna.de/)                          | [Jonas Thomsen](https://github.com/JoThomsen)                                                                                                                                                                                                                    | Developer Portal, documentation, monitoring, service catalog for our insurance ecosystem                                                                                                                                                                                                                                                             |
 | [Tradeshift](https://www.tradeshift.com/)                                   | [Soren Mathiasen](https://github.com/sorenmat)                                                                                                                                                                                                                   | Developer Portal: documentation, monitoring, service templates, service catalog for our micro services                                                                                                                                                                                                                                               |
 | [Unity](https://unity.com)                                                  | [Ted Cordery](https://github.com/TeddyBallGame)                                                                                                                                                                                                                  | A centralized service catalog with documentation for our service engineers.                                                                                                                                                                                                                                                                          |
-| [PicPay](https://www.picpay.com)                                            | [Luis Baroni](https://github.com/lcsbaroni), [Renata Poluceno](https://github.com/renatapoluceno), [PicPay](https://github.com/picpay)                                                                                                                           | Developer portal for building services throught templates, service catalog with ownership of services, documentation and metrics providing autonomy and visibility for all.                                                                                                                                                                          |
+| [PicPay](https://www.picpay.com)                                            | [Luis Baroni](https://github.com/lcsbaroni), [Renata Poluceno](https://github.com/renatapoluceno), [PicPay](https://github.com/picpay)                                                                                                                           | Developer portal for building services through templates, service catalog with ownership of services, documentation and metrics providing autonomy and visibility for all.                                                                                                                                                                          |
 | [Epic Games](https://www.epicgames.com)                                     | [Brian Jung](https://github.com/brian-at-epic), [Jeff Goldian](https://github.com/jeffgoldian-Epic)                                                                                                                                                              | Developer Portal: Service Catalog, Documentation, Software Templates and more making our internal teams' lives easier!                                                                                                                                                                                                                               |
 | [Globo](https://globo.com)                                                  | [Carlos Gusmão](https://github.com/caeugusmao), [Guilherme Vierno](https://github.com/vierno), [Denis Aoki](https://github.com/dnsaoki2), [Maycon Dionisio](https://github.com/MayconDionisio),                                                                  | Reduce the friction of accessing the information engineers need about Globo's digital services through a coherent and centralized experience.                                                                                                                                                                                                        |
 | [QBE](https://www.qbe.com/)                                                 | [Daniel Steel](https://github.com/danielsteelqbe), [Pete Jespers](https://github.com/petejespersqbe)                                                                                                                                                             | Developer portal allowing our global teams to explore and create applications, documentation and cloud infrastructure easily and quickly 🚀                                                                                                                                                                                                          |
@@ -45,7 +45,7 @@ const GoodComponent = ({ text, children }: GoodProps) => (
  </div>
 );

-/* Or as a shorthand, if no specifc child type is required */
+/* Or as a shorthand, if no specific child type is required */
 type GoodProps = PropsWithChildren<{ text: string }>;
 const GoodComponent = ({ text, children }: GoodProps) => (
  <div>
@@ -525,7 +525,7 @@
                    </div>
                </foreignObject>
                <text x="491" y="557" fill="#5C5C5C" font-family="Helvetica" font-size="9px" text-anchor="middle">
-                    Compile and Execut...
+                    Compile and Execute...
                </text>
            </switch>
        </g>
@@ -255,7 +255,7 @@ CPU/Memory for pods returned by the API server. Defaults to `false`.

 ##### `exposeDashboard`

-This determines wether the `dashboardApp` and `dashboardParameters` should be
+This determines whether the `dashboardApp` and `dashboardParameters` should be
 automatically configured in order to expose the GKE dashboard from the
 Kubernetes plugin.

@@ -251,7 +251,7 @@ use `ui:widget: password` or set some properties of `ui:backstage`:
      type: string
      ui:backstage:
        review:
-          show: false # wont print any info about 'hidden' property on Review Step
+          show: false # won't print any info about 'hidden' property on Review Step
 ```

 ### The Repository Picker
@@ -66,7 +66,7 @@ These steps are generally kept isolated form each other, with each step focusing
 on its specific task. For example, we do not do linting or type checking
 together with the building or bundling. This is so that we can provide more
 flexibility and avoid duplicate work, improving performance. It is strongly
-recommended that as a part of developing withing Backstage you use a code editor
+recommended that as a part of developing within Backstage you use a code editor
 or IDE that has support for formatting, linting, and type checking.

 Let's dive into a detailed look at each of these steps and how they are
@@ -3,7 +3,7 @@ title: Opsgenie
 author: K-Phoen
 authorUrl: https://github.com/K-Phoen
 category: Monitoring
-description: Opsgenie offers a simple way to associate alerts to components and vizualize incidents.
+description: Opsgenie offers a simple way to associate alerts to components and visualize incidents.
 documentation: https://github.com/K-Phoen/backstage-plugin-opsgenie/
 iconUrl: https://avatars.githubusercontent.com/u/1818843?s=200&v=4
 npmPackageName: '@k-phoen/backstage-plugin-opsgenie'
@@ -93,7 +93,7 @@ describe('DatabaseManager', () => {
          plugin: {
            testdbname: {
              connection: {
-                database: 'database_name_overriden',
+                database: 'database_name_overridden',
              },
            },
            differentclient: {
@@ -304,10 +304,10 @@ describe('DatabaseManager', () => {
      const mockCalls = mocked(createDatabaseClient).mock.calls.splice(-1);
      const [_baseConfig, overrides] = mockCalls[0];

-      // simple case where only database name is overriden
+      // simple case where only database name is overridden
      expect(overrides).toMatchObject({
        connection: {
-          database: 'database_name_overriden',
+          database: 'database_name_overridden',
        },
      });
    });
@@ -581,7 +581,7 @@ describe('DatabaseManager', () => {
              plugin: {
                testdbname: {
                  connection: {
-                    database: 'database_name_overriden',
+                    database: 'database_name_overridden',
                    host: 'newhost',
                  },
                },
@@ -599,7 +599,7 @@ describe('DatabaseManager', () => {
      expect(baseConfig.get()).toMatchObject({
        client: 'pg',
        connection: {
-          database: 'database_name_overriden',
+          database: 'database_name_overridden',
          host: 'newhost',
          user: 'foo',
          password: 'bar',
@@ -608,7 +608,7 @@ describe('DatabaseManager', () => {
      expect(overrides).toHaveProperty('searchPath', ['testdbname']);
      expect(overrides).toHaveProperty(
        'connection.database',
-        'database_name_overriden',
+        'database_name_overridden',
      );
    });

@@ -193,7 +193,7 @@ describe('database connection', () => {
  });

  describe('ensureSchemaExists', () => {
-    it('returns sucessfully with pg client', async () => {
+    it('returns successfully with pg client', async () => {
      await ensureSchemaExists(
        new ConfigReader({
          client: 'pg',
@@ -529,7 +529,7 @@ spec:
      terrains: [String]

      """
-      The percentage of the planet surface that is naturally occuring water or bodies
+      The percentage of the planet surface that is naturally occurring water or bodies
      of water.
      """
      surfaceWater: Float
@@ -16,7 +16,7 @@

 /**
 * NOTE: This is a worker thread function that is stringified and executed
- *       withing a `worker_threads.Worker`. Everything in this function must
+ *       within a `worker_threads.Worker`. Everything in this function must
 *       be self-contained.
 *       Using TypeScript is fine as it is transpiled before being stringified.
 */
@@ -19,7 +19,7 @@ export type WriteFileFunc = (contents: string) => Promise<void>;
 export type FileDiff = {
  // Relative path within the target directory
  path: string;
-  // Wether the target file exists in the target directory.
+  // Whether the target file exists in the target directory.
  missing: boolean;
  // Contents of the file in the target directory, or an empty string if the file is missing.
  targetContents: string;
@@ -190,7 +190,7 @@ export type AppOptions = {

  /**
   * A collection of ApiFactories to register in the application as default APIs.
-   * Theses APIs can not be overridden by plugin factories, but can be overridden
+   * These APIs cannot be overridden by plugin factories, but can be overridden
   * by plugin APIs provided through the
   * A collection of ApiFactories to register in the application to either
   * add new ones, or override factories provided by default or by plugins.
@@ -93,7 +93,7 @@ export const routeParentCollector = createCollector(
        acc.set(routeRef, parentRouteRef.sticky);

        // When we encounter a mount point with an explicit path, we stop gathering
-        // mount points withing the children and remove the sticky state
+        // mount points within the children and remove the sticky state
        if (node.props?.path) {
          nextParent = routeRef;
        } else {
@@ -20,7 +20,7 @@ import { renderWithEffects, wrapInTestApp } from '@backstage/test-utils';
 import Button from '@material-ui/core/Button';

 describe('<EmptyState />', () => {
-  it('render EmptyState component with type annotaion is missing', async () => {
+  it('render EmptyState component with type annotation is missing', async () => {
    const rendered = await renderWithEffects(
      wrapInTestApp(
        <EmptyState
@@ -151,7 +151,7 @@ export function SidebarPage(props: SidebarPageProps) {
 * This hook provides a react ref to the main content.
 * Allows to set an element as the main content and focus on that component.
 *
- * *Note: If `contentRef` is not set `focusContent` is noop. `Content` component sets this ref automaticaly*
+ * *Note: If `contentRef` is not set `focusContent` is noop. `Content` component sets this ref automatically*
 *
 * @public
 * @example
@@ -56,7 +56,7 @@ export type SidebarContextType = {
 };

 /**
- * Context wether the `Sidebar` is open
+ * Context whether the `Sidebar` is open
 */
 export const SidebarContext = createContext<SidebarContextType>({
  isOpen: false,
@@ -17,7 +17,7 @@
 import { ApiRef, createApiRef } from '../system';

 /**
- * Fetaure flag descriptor.
+ * Feature flag descriptor.
 *
 * @public
 */
@@ -148,7 +148,7 @@ export class DevAppBuilder {
  }

  /**
-   * Adds an array of themes to overide the default theme.
+   * Adds an array of themes to override the default theme.
   */
  addThemes(themes: AppTheme[]) {
    this.themes = themes;
@@ -54,7 +54,7 @@ const nullObservable = {

 /**
 * Mock implementation of the {@link core-plugin-api#ErrorApi} to be used in tests.
- * Incudes withForError and getErrors methods for error testing.
+ * Includes withForError and getErrors methods for error testing.
 * @public
 */
 export class MockErrorApi implements ErrorApi {
@@ -529,7 +529,7 @@ spec:
      terrains: [String]

      """
-      The percentage of the planet surface that is naturally occuring water or bodies
+      The percentage of the planet surface that is naturally occurring water or bodies
      of water.
      """
      surfaceWater: Float
@@ -44,7 +44,7 @@ export interface Badge {
  link?: string;
  /** Badge message */
  message: string;
-  /** Badge style (apperance). One of "plastic", "flat", "flat-square", "for-the-badge" and "social" */
+  /** Badge style (appearance). One of "plastic", "flat", "flat-square", "for-the-badge" and "social" */
  style?: BadgeStyle;
 }

@@ -58,7 +58,7 @@ export interface Config {
          clientSecret: string;

          // TODO: Consider not making these config options and pass them in the
-          // constructor instead. They are probably not environment specifc, so
+          // constructor instead. They are probably not environment specific, so
          // they could also be configured "in code".

          /**
@@ -157,7 +157,7 @@ describe('MicrosoftGraphClient', () => {
    expect(userProfile).toEqual({ surname: 'Example' });
  });

-  it('should throw expection if load user profile fails', async () => {
+  it('should throw exception if load user profile fails', async () => {
    worker.use(
      rest.get('https://example.com/users/user-id', (_, res, ctx) =>
        res(ctx.status(404)),
@@ -131,7 +131,7 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer {
  constructor(private readonly rules: CatalogRule[]) {}

  /**
-   * Checks wether a specific entity/location combination is allowed
+   * Checks whether a specific entity/location combination is allowed
   * according to the configured rules.
   */
  isAllowed(entity: Entity, location: LocationSpec) {
@@ -76,7 +76,7 @@ describe('CodeOwnersProcessor', () => {
      expect(result).toEqual(entity);
    });

-    it('should ingore invalid locations type', async () => {
+    it('should ignore invalid locations type', async () => {
      const { entity, processor } = setupTest();

      const result = await processor.preProcessEntity(
@@ -38,7 +38,7 @@ import {
 */
 export type RelationPairs = [string, string][];

-// TODO: This file only contains the pairs for the build-in relations.
+// TODO: This file only contains the pairs for the built-in relations.
 //  How to implement this when custom relations are used? Right now you can pass
 //  the relations everywhere.
 //  Another option is to move this into @backstage/catalog-model
@@ -448,7 +448,7 @@ describe('<AboutCard />', () => {
    expect(getByText('View TechDocs').closest('a')).not.toHaveAttribute('href');
  });

-  it('renders disbaled techdocs link when route is not bound', async () => {
+  it('renders disabled techdocs link when route is not bound', async () => {
    const entity = {
      apiVersion: 'v1',
      kind: 'Component',
@@ -47,7 +47,7 @@ export const statusTypes: Array<FilterStatusType> = [
 /**
 * The branch enum of either 'master' or 'branch' (or possibly the meta 'all').
 *
- * The concept of what constitues a master branch is generic. It might be called
+ * The concept of what constitutes a master branch is generic. It might be called
 * something like 'release' or 'main' or 'trunk' in the underlying CI/CD system,
 * which is then up to the Api to map accordingly.
 */
@@ -27,7 +27,7 @@ export class Cobertura implements Converter {
   * convert cobertura into shared json coverage format
   *
   * @param xml - cobertura xml object
-   * @param scmFiles - list of files that are commited to SCM
+   * @param scmFiles - list of files that are committed to SCM
   */
  convert(xml: CoberturaXML, scmFiles: string[]): FileEntry[] {
    const ppc = xml.coverage.packages
@@ -104,7 +104,7 @@ export const BarChart = ({
    .slice(stepStart, stepEnd);

  // Pin the domain to the largest value in the series.
-  // Intentially redundant - This could simply be derived from the first element in the already sorted list,
+  // Intentionally redundant - This could simply be derived from the first element in the already sorted list,
  // but that may not be the case in the future when custom sorting is implemented.
  const globalResourcesMax = resources.reduce(
    (max, r: ResourceData) => Math.max(max, r.current, r.previous),
@@ -17,7 +17,7 @@ import React, { useEffect, useRef } from 'react';
 import { ScrollTo, useScroll } from '../hooks/useScroll';

 /*
-  Utility component use in conjuction with useScroll that allows scrollable components to control behavior and offset.
+  Utility component use in conjunction with useScroll that allows scrollable components to control behavior and offset.
  1. ScrollAnchor must be a direct child of a scrollable component.
  2. ScrollAnchor's parent position must be relative. 
  3. ScrollAnchor's id must be unique.
@@ -52,7 +52,7 @@ describe('Differ', () => {
    expect(next).not.toBeInTheDocument();
  });

-  it('should render icon & current & next (with seperator)', () => {
+  it('should render icon & current & next (with separator)', () => {
    const { getByTestId, queryByTestId } = render(
      <Differ
        icon="branch"
@@ -53,7 +53,7 @@ export function Features({
  if (gitBatchInfo.error) {
    return (
      <Alert severity="error">
-        Error occured while fetching information for "{project.owner}/
+        Error occurred while fetching information for "{project.owner}/
        {project.repo}" ({gitBatchInfo.error.message})
      </Alert>
    );
@@ -332,7 +332,7 @@ describe('JenkinsApi', () => {
        const result = await jenkinsApi.getProjects(jenkinsInfo);

        expect(result).toHaveLength(1);
-        // TODO: I am really just asserting the previous behaviour wth no understanding here.
+        // TODO: I am really just asserting the previous behaviour with no understanding here.
        // In my 2 Jenkins instances, 1 returns a lot of different and confusing BuildData sections and 1 returns none ☹️
        expect(result[0].lastBuild!.source).toEqual({
          branchName: 'master',
@@ -97,7 +97,7 @@ export class JenkinsConfig {
    const unnamedAllPresent = baseUrl && username && apiKey;
    if (!(unnamedAllPresent || unnamedNonePresent)) {
      throw new Error(
-        `Found partial default jenkins config. All (or none) of  baseUrl, username ans apiKey must be provided.`,
+        `Found partial default jenkins config. All (or none) of baseUrl, username and apiKey must be provided.`,
      );
    }

@@ -14,6 +14,6 @@
 * limitations under the License.
 */
 export const JENKINS_ANNOTATION = 'jenkins.io/job-full-name';
-// @deprecated The legacy annotation used for identifing Jenkins jobs, use
+// @deprecated The legacy annotation used for identifying Jenkins jobs, use
 // JENKINS_ANNOTATION instead.
 export const LEGACY_JENKINS_ANNOTATION = 'jenkins.io/github-folder';
@@ -110,7 +110,7 @@ export interface ClusterDetails {
   * @remarks
   * Note that you should specify the app used for the dashboard
   * using the dashboardApp property, in order to properly format
-   * links to kubernetes resources,  otherwise it will assume that you're running the standard one.
+   * links to kubernetes resources, otherwise it will assume that you're running the standard one.
   * @see dashboardApp
   * @see dashboardParameters
   */
@@ -231,7 +231,7 @@ describe('detectErrors', () => {
    expect(errors).toBeDefined();
    expect(errors).toHaveLength(0);
  });
-  it('should detect in deployment which cant progress', () => {
+  it('should detect in deployment which cannot progress', () => {
    const result = detectErrors(oneDeployment(failingDeploy as any));

    expect(result.size).toBe(1);
@@ -71,7 +71,7 @@ export const DashboardSnapshot = ({
                  src={url}
                />
              ) : (
-                'Dashboard loading... , click here to open if it didnt render correctly'
+                'Dashboard loading... , click here to open if it did not render correctly'
              )}
            </Link>
          </Box>
@@ -79,7 +79,7 @@ export type PermissionCondition<TParams extends unknown[] = unknown[]> = {
 type NonEmptyArray<T> = [T, ...T[]];

 /**
- * Represnts a logical AND for the provided criteria.
+ * Represents a logical AND for the provided criteria.
 * @public
 */
 export type AllOfCriteria<TQuery> = {
@@ -87,7 +87,7 @@ export type AllOfCriteria<TQuery> = {
 };

 /**
- * Represnts a logical OR for the provided criteria.
+ * Represents a logical OR for the provided criteria.
 * @public
 */
 export type AnyOfCriteria<TQuery> = {
@@ -21,7 +21,7 @@ import {
 import { ApiRef, createApiRef } from '@backstage/core-plugin-api';

 /**
- * This API is used by various frontend utilities that allow developers to implement authorization wihtin their frontend
+ * This API is used by various frontend utilities that allow developers to implement authorization within their frontend
 * plugins. A plugin developer will likely not have to interact with this API or its implementations directly, but
 * rather with the aforementioned utility components/hooks.
 * @public
@@ -115,7 +115,7 @@ describe('fetch:cookiecutter', () => {
      });
    });

-    // Mock when executeShellCommand is called it creats some new files in the mock filesystem
+    // Mock when executeShellCommand is called it creates some new files in the mock filesystem
    executeShellCommand.mockImplementation(async () => {
      mockFs({
        [`${join(mockTmpDir, 'intermediate')}`]: {
@@ -339,7 +339,7 @@ describe('DefaultWorkflowRunner', () => {
      expect(logger.error).not.toHaveBeenCalled();
    });

-    it('should keep the original types for the input and not parse things that arent meant to be parsed', async () => {
+    it('should keep the original types for the input and not parse things that are not meant to be parsed', async () => {
      const task = createMockTaskWithSpec({
        apiVersion: 'scaffolder.backstage.io/v1beta3',
        steps: [
@@ -73,7 +73,7 @@ export type ScaffolderTaskOutput = {

 /**
 * The shape of each entry of parameters which gets rendered
- * as a seperate step in the wizard input
+ * as a separate step in the wizard input
 *
 * @public
 */
@@ -61,7 +61,7 @@ describe('Scheduler', () => {
      // Stop scheduling process
      testScheduler.stop();

-      // Should't throw error, as it is stopped.
+      // Shouldn't throw error, as it is stopped.
      expect(() =>
        testScheduler.addToSchedule(mockTask2, 4),
      ).not.toThrowError();
@@ -932,7 +932,7 @@ describe('LunrSearchEngine', () => {
      });
      inspectableSearchEngine.setDocStore({ 'existing-location': doc });

-      // Mock methds called by close handler.
+      // Mock methods called by close handler.
      indexerMock.buildIndex.mockReturnValueOnce('expected-index');
      indexerMock.getDocumentStore.mockReturnValueOnce({
        'new-location': doc,
@@ -68,7 +68,7 @@ export class LunrSearchEngine implements SearchEngine {
      lunrQueryBuilder: q => {
        const termToken = lunr.tokenizer(term);

-        // Support for typeahead seach is based on https://github.com/olivernn/lunr.js/issues/256#issuecomment-295407852
+        // Support for typeahead search is based on https://github.com/olivernn/lunr.js/issues/256#issuecomment-295407852
        // look for an exact match and apply a large positive boost
        q.term(termToken, {
          usePipeline: true,
@@ -43,7 +43,7 @@ export const useAsyncFilterValues = (
      // for the lifetime of the hook/component.
      if (valuesMemo.current[inputValue] === undefined) {
        valuesMemo.current[inputValue] = callback(inputValue).then(values => {
-          // Overrite the value for future immediate returns.
+          // Override the value for future immediate returns.
          valuesMemo.current[inputValue] = values;
          return values;
        });
@@ -203,7 +203,7 @@ describe('DefaultTechDocsCollatorFactory', () => {
      const pipeline = TestPipeline.withSubject(collator);
      const { documents } = await pipeline.execute();

-      // Only 1 entity with TechDocs configured multipled by 3 pages.
+      // Only 1 entity with TechDocs configured multiplied by 3 pages.
      expect(documents).toHaveLength(3);
    });

@@ -216,7 +216,7 @@ describe('getCloudPathForLocalPath', () => {
    );
  });

-  it('should add trailing seperator to root directory', () => {
+  it('should add trailing separator to root directory', () => {
    const localPath = 'index/html';
    const rootPath = 'backstage-data/techdocs';
    const remoteBucket = getCloudPathForLocalPath(
@@ -230,7 +230,7 @@ describe('getCloudPathForLocalPath', () => {
    );
  });

-  it('should remove leading seperator from root directory', () => {
+  it('should remove leading separator from root directory', () => {
    const localPath = 'index/html';
    const rootPath = '/backstage-data/techdocs/';
    const remoteBucket = getCloudPathForLocalPath(
@@ -244,7 +244,7 @@ describe('getCloudPathForLocalPath', () => {
    );
  });

-  it('should ignore seperator if root directory is explicitly defined', () => {
+  it('should ignore separator if root directory is explicitly defined', () => {
    const localPath = 'index/html';
    const rootPath = '/';
    const remoteBucket = getCloudPathForLocalPath(
@@ -45,7 +45,7 @@ describe('Entity Docs Card Grid', () => {
    jest.resetAllMocks();
  });

-  it('should render all entities passed ot it', async () => {
+  it('should render all entities passed to it', async () => {
    const { findByText, findAllByRole } = render(
      wrapInTestApp(
        <DocsCardGrid
@@ -9,7 +9,7 @@ Transformers are functions that optionally takes in parameters from the Reader.t
 ```typescript
 export const updateH1Text = (): Transformer => {
  return dom => {
-    // Change the first occurance of H1 to say "TechDocs!"
+    // Change the first occurrence of H1 to say "TechDocs!"
    dom.querySelector('h1')?.innerHTML = 'TechDocs!';

    return dom;
@@ -53,7 +53,7 @@ describe('BuildList', () => {
    );

    userEvent.click(
-      (await rendered.findAllByLabelText('Detail panel visiblity toggle'))[0],
+      (await rendered.findAllByLabelText('Detail panel visibility toggle'))[0],
    );
    expect(await rendered.findByText('BuildDetails')).toBeInTheDocument();
  });