fix some little things that vale was complaining about

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-12-10 14:28:25 +01:00
parent f645a8dee6
commit 973dd6f25d
17 changed files with 32 additions and 25 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend-module-github': patch
+---
+
+Minor spell fix in action parameters
@@ -80,6 +80,8 @@ cron
 cronjobs
 crontab
 css
+cve
+CVEs
 daemonsets
 Datadog
 dataflow
@@ -339,6 +341,7 @@ rebase
 rebasing
 Recharts
 Redash
+redis
 renderer
 renderers
 replicasets
@@ -186,7 +186,7 @@ import { useShadowRootElements } from '@backstage/plugin-techdocs-react';
 // difference is that you'd set `location` to `TechDocsAddonLocations.Content`.
 export const MakeAllImagesCatGifsAddon = () => {
  // This hook can be used to get references to specific elements. If you need
-  // access to the whole shadow DOM, use the the underlying useShadowRoot()
+  // access to the whole shadow DOM, use the underlying useShadowRoot()
  // hook instead.
  const images = useShadowRootElements<HTMLImageElement>(['img']);

@@ -169,4 +169,4 @@ If you want to read more about the database configuration, here are some helpful

 - [Configuring Plugin Databases](../../tutorials/configuring-plugin-databases.md#privileges)
 - [Read more about Knex](http://knexjs.org/), the database wrapper that we use.
- [Install pgAdmin 4](https://www.pgadmin.org/), a helpful tool for querying your database.
+- [Install `pgAdmin` 4](https://www.pgadmin.org/), a helpful tool for querying your database.
@@ -32,7 +32,7 @@ dependencies that they have between each other.

 :::tip

-To make the the version bump process even easier and more streamlined we highly recommend using the [Backstage yarn plugin](#managing-package-versions-with-the-backstage-yarn-plugin)
+To make the version bump process even easier and more streamlined we highly recommend using the [Backstage yarn plugin](#managing-package-versions-with-the-backstage-yarn-plugin)

 :::

@@ -94,31 +94,31 @@ Examples of tactics we have used to evangelize Backstage internally:
 These are some of the metrics that you can use to verify if Backstage has a
 successful impact on your software development process:

- **Onboarding time** Time until new engineers are productive. At Spotify we
+- **Onboarding time** - Time until new engineers are productive. At Spotify we
  measure this as the time until the employee has merged their 10th PR (this
  metric was down 55% two years after deploying Backstage). Even though you may
  not be onboarding engineers at a rapid pace, this metric is a great proxy for
  the overall complexity of your ecosystem. Reducing it will therefore benefit
  your whole engineering organization, not just new joiners.

- **Number of merges per developer/day** Less time spent jumping between
+- **Number of merges per developer/day** - Less time spent jumping between
  different tools and looking for information means more time to focus on
  shipping code. A second level of bottlenecks can be identified if you
  categorize contributions by domain (services, web, data, etc).

- **Deploys to production** Cousin to the metric above: How many times does an
+- **Deploys to production** - Cousin to the metric above: How many times does an
  engineer push changes into production.

- **MTTR** With clear ownership of all the pieces in your microservices
+- **MTTR** - With clear ownership of all the pieces in your microservices
  ecosystem and all tools integrated into one place, Backstage makes it quicker
  for teams to find the root cause of failures, and fix them.

- **Context switching** Reducing context switching can help engineers stay in
+- **Context switching** - Reducing context switching can help engineers stay in
  the "zone". We measure the number of different tools an engineer has to
  interact with in order to get a certain job done (e.g. push a change, follow
  it into production and validate it did not break anything).

- **T-shapedness** A
+- **T-shapedness** - A
  [T-shaped](https://medium.com/@jchyip/why-t-shaped-people-e8706198e437)
  engineer is someone that is able to contribute to different domains of
  engineering. Teams with T-shaped people have fewer bottlenecks and can
@@ -126,10 +126,10 @@ successful impact on your software development process:
  since tools and infrastructure are consistent between domains, and information
  is available centrally.

- **eNPS** Surveys asking about how productive people feel, how easy it is to
+- **eNPS** - Surveys asking about how productive people feel, how easy it is to
  find information and overall satisfaction with internal tools.

- **Fragmentation** _(Experimental)_ Backstage
+- **Fragmentation** _(Experimental)_ - Backstage
  [Software Templates](../features/software-templates/index.md) help drive
  standardization in your software ecosystem. By measuring the variance in
  technology between different software components it is possible to get a sense
@@ -40,7 +40,7 @@ Deploy CLI makes use of [Pulumi](https://www.pulumi.com/docs/) which is an infra

 You can find the step-by-step installation documentation for Pulumi under the [Deployment section](https://backstage.io/docs/deployment/backstage-deploy/aws-lightsail).

-But we summarize the steps to deploy your POC here. You can invoke the the CLI you can use the following command:
+But we summarize the steps to deploy your POC here. You can invoke the CLI you can use the following command:

 ```bash
 $ npx backstage-deploy aws --create-dockerfile
@@ -41,7 +41,7 @@ if (process.env.BACKSTAGE_CLI_LINKED_WORKSPACE) {
    }

    // The package import that we're overriding will always existing in the root
-    // node_modules of the linked workspace, so it's enough to override the the
+    // node_modules of the linked workspace, so it's enough to override the
    // parent paths with that single entry
    return origLoad.call(this, request, {
      ...parent,
@@ -39,7 +39,7 @@ export interface ReadConfigDataOptions {
 }

 /**
- * The the generator returned by {@link ConfigSource.readConfigData}.
+ * The generator returned by {@link ConfigSource.readConfigData}.
 *
 * @public
 */
@@ -26,7 +26,7 @@ const ERROR_PREFIX = 'Invalid discovery URL pattern,';
 */
 export class UrlPatternDiscovery implements DiscoveryApi {
  /**
-   * Creates a new UrlPatternDiscovery given a template. The the only
+   * Creates a new UrlPatternDiscovery given a template. The only
   * interpolation done for the template is to replace instances of `{{pluginId}}`
   * with the ID of the plugin being requested.
   *
@@ -43,14 +43,14 @@ describe('TrendLine', () => {
    });
  });

-  describe.skip('when the data finishes within the the warning threshold', () => {
+  describe.skip('when the data finishes within the warning threshold', () => {
    it('renders with the correct color', async () => {
      await renderInTestApp(<TrendLine data={[0.5, 0.65]} title="sparkline" />);
      expect(screen.getByTitle('sparkline')).toBeInTheDocument();
    });
  });

-  describe.skip('when the data finishes within the the error threshold', () => {
+  describe.skip('when the data finishes within the error threshold', () => {
    it('renders with the correct color', async () => {
      await renderInTestApp(<TrendLine data={[0.5, 0.4]} title="sparkline" />);
      expect(screen.getByTitle('sparkline')).toBeInTheDocument();
@@ -98,7 +98,7 @@ describe('PageBlueprint', () => {

    const tester = createExtensionTester(myPage);

-    // TODO(blam): test for the routePath output doesn't work, due to the the way the test harness works
+    // TODO(blam): test for the routePath output doesn't work, due to the way the test harness works
    // expect(tester.data(coreExtensionData.routePath)).toBe('/test');

    expect(tester.get(coreExtensionData.routeRef)).toBe(mockRouteRef);
@@ -296,7 +296,7 @@ export function resolveRelations(
  groupMember: Map<string, Set<string>>,
  groupMemberOf: Map<string, Set<string>>,
 ) {
-  // Build reference lookup tables, we reference them by the id the the graph
+  // Build reference lookup tables, we reference them by the id of the graph
  const groupMap: Map<string, GroupEntity> = new Map(); // by group-id or tenant-id

  for (const group of groups) {
@@ -283,7 +283,7 @@ describe('DefaultProcessingDatabase', () => {
    );

    it.each(databases.eachSupportedId())(
-      'adds deferred entities to the the refresh_state table to be picked up later, %p',
+      'adds deferred entities to the refresh_state table to be picked up later, %p',
      async databaseId => {
        const { knex, db } = await createDatabase(databaseId);
        await insertRefreshStateRow(knex, {
@@ -69,7 +69,7 @@ export class DefaultStarredEntitiesApi implements StarredEntitiesApi {
  >();

  private readonly observable = new ObservableImpl<Set<string>>(subscriber => {
-    // forward the the latest value
+    // forward the latest value
    subscriber.next(new Set(this.starredEntities));

    this.subscribers.add(subscriber);
@@ -67,14 +67,13 @@ export function createGithubPagesEnableAction(options: {
          sourceBranch: {
            title: 'Source Branch',
            type: 'string',
-            description:
-              'The the GitHub Pages source branch. Default is "main"',
+            description: 'The GitHub Pages source branch. Default is "main"',
          },
          sourcePath: {
            title: 'Source Path',
            type: 'string',
            description:
-              'The the GitHub Pages source path - "/" or "/docs". Default is "/"',
+              'The GitHub Pages source path - "/" or "/docs". Default is "/"',
          },
          token: {
            title: 'Authorization Token',