just getting rid of vale warnings

Signed-off-by: Fredrik Adelöw <[email protected]>

Author: freben

.changeset/gorgeous-balloons-sit.md

@@ -0,0 +1,9 @@
+---
+'@backstage/plugin-auth-backend': patch
+'@backstage/plugin-cost-insights': patch
+'@backstage/plugin-dynatrace': patch
+'@backstage/plugin-stack-overflow-backend': patch
+'@backstage/plugin-techdocs': patch
+---
+
+Tweak README

.github/vale/Vocab/Backstage/accept.txt

@@ -1,5 +1,6 @@
 abc
 accessors
+ACLs
 addon
 addons
 ADRs
@@ -17,6 +18,7 @@ autoscaling
 Autoscaling
 autoselect
 Avro
+backend's
 backported
 backporting
 Bigtable
@@ -88,6 +90,8 @@ dockerfiles
 Dockerize
 dockerode
 Docusaurus
+DOMPurify
+don'ts
 dynatrace
 Dynatrace
 ecco
@@ -96,6 +100,8 @@ Env
 elasticsearch
 esbuild
 eslint
+ESModule
+ESModules
 etag
 Expedia
 facto
@@ -136,8 +142,10 @@ iLert
 img
 incentivised
 Indal
+indexable
 inlined
 inlinehilite
+integrator's
 interop
 JaCoCo
 JavaScript
@@ -168,6 +176,7 @@ lunr
 Luxon
 magiclink
 mailto
+maintainer's
 maintainership
 makefile
 md
@@ -222,6 +231,7 @@ orgs
 pagerduty
 pageview
 parallelization
+parseable
 Patrik
 Peloton
 performant
@@ -306,6 +316,10 @@ stringify
 stringified
 subcomponent
 subcomponents
+subfolder
+subfolders
+subheader
+subheaders
 subkey
 subroutes
 subtree
@@ -326,6 +340,7 @@ templater
 Templater
 templaters
 Templaters
+TFRecord
 theia
 thumbsup
 todo
@@ -365,6 +380,7 @@ VSCode
 Wayfair
 Weaveworks
 Webpack
+widget's
 winston
 www
 WWW

STYLE.md

@@ -11,8 +11,8 @@ Our TypeScript style is inspired by the [style guidelines](https://github.com/Mi
 1. Use PascalCase for type names.
 1. Do not use `I` as a prefix for interface names.
 1. Use PascalCase for `enum` values.
-1. Use camelCase for function names.
-1. Use camelCase for property names and local variables.
+1. Use `camelCase` for function names.
+1. Use `camelCase` for property names and local variables.
 1. Do not use `_` as a prefix for private properties.
 1. Use whole words in names when possible.
 1. Give type parameters names prefixed with `T`, for example `Request<TBody>`.

docs/api/utility-apis.md

@@ -13,31 +13,31 @@ both with other plugins and the app itself.
 
 Backstage provides two primary methods for plugins to communicate across their
 boundaries in client-side code. The first one being the
-[createPlugin](../reference/core-plugin-api.createplugin.md) API along with the
+[`createPlugin`](../reference/core-plugin-api.createplugin.md) API along with the
 extensions that it can provide, and the second one being Utility APIs. While the
-[createPlugin](../reference/core-plugin-api.createplugin.md) API is focused on
+[`createPlugin`](../reference/core-plugin-api.createplugin.md) API is focused on
 the initialization plugins and the app, the Utility APIs provide ways for
 plugins to communicate during their entire life cycle.
 
 ## Consuming APIs
 
-Each Utility API is tied to an [ApiRef](../reference/core-plugin-api.apiref.md)
+Each Utility API is tied to an [`ApiRef`](../reference/core-plugin-api.apiref.md)
 instance, which is a global singleton object without any additional state or
 functionality, its only purpose is to reference Utility APIs.
-[ApiRef](../reference/core-plugin-api.apiref.md)s are created using
-[createApiRef](../reference/core-plugin-api.createapiref.md), which is exported
-by [@backstage/core-plugin-api](../reference/core-plugin-api.md). There are also
+[`ApiRef`](../reference/core-plugin-api.apiref.md)s are created using
+[`createApiRef`](../reference/core-plugin-api.createapiref.md), which is exported
+by [`@backstage/core-plugin-api`](../reference/core-plugin-api.md). There are also
 many predefined Utility APIs in
-[@backstage/core-plugin-api](../reference/core-plugin-api.md), and they're all
+[`@backstage/core-plugin-api`](../reference/core-plugin-api.md), and they're all
 exported with a name of the pattern `*ApiRef`, for example
-[errorApiRef](../reference/core-plugin-api.errorapiref.md).
+[`errorApiRef`](../reference/core-plugin-api.errorapiref.md).
 
 To access one of the Utility APIs inside a React component, use the
-[useApi](../reference/core-plugin-api.useapi.md) hook exported by
-[@backstage/core-plugin-api](../reference/core-plugin-api.md), or the
-[withApis](../reference/core-plugin-api.withapis.md) HOC if you prefer class
+[`useApi`](../reference/core-plugin-api.useapi.md) hook exported by
+[`@backstage/core-plugin-api`](../reference/core-plugin-api.md), or the
+[`withApis`](../reference/core-plugin-api.withapis.md) HOC if you prefer class
 components. For example, the
-[ErrorApi](../reference/core-plugin-api.errorapi.md) can be accessed like this:
+[`ErrorApi`](../reference/core-plugin-api.errorapi.md) can be accessed like this:
 
 ```tsx
 import React from 'react';
@@ -56,30 +56,30 @@ export const MyComponent = () => {
 ```
 
 Note that there is no explicit type given for
-[ErrorApi](../reference/core-plugin-api.errorapi.md). This is because the
-[errorApiRef](../reference/core-plugin-api.errorapiref.md) has the type
-embedded, and [useApi](../reference/core-plugin-api.useapi.md) is able to infer
+[`ErrorApi`](../reference/core-plugin-api.errorapi.md). This is because the
+[`errorApiRef`](../reference/core-plugin-api.errorapiref.md) has the type
+embedded, and [`useApi`](../reference/core-plugin-api.useapi.md) is able to infer
 the type.
 
 Also note that consuming Utility APIs is not limited to plugins, it can be done
 from any component inside Backstage, including the ones in
-[@backstage/core-plugin-api](../reference/core-plugin-api.md). The only
+[`@backstage/core-plugin-api`](../reference/core-plugin-api.md). The only
 requirement is that they are beneath the `AppProvider` in the react tree.
 
 ## Supplying APIs
 
 ### API Factories
 
 APIs are registered in the form of
-[ApiFactories](../reference/core-plugin-api.apifactory.md), which encapsulate
+[`ApiFactory`](../reference/core-plugin-api.apifactory.md) instances, which encapsulate
 the process of instantiating an API. It is a collection of three things: the
-[ApiRef](../reference/core-plugin-api.apiref.md) of the API to instantiate, a
+[`ApiRef`](../reference/core-plugin-api.apiref.md) of the API to instantiate, a
 list of all required dependencies, and a factory function that returns a new API
 instance.
 
 For example, this is the default
-[ApiFactory](../reference/core-plugin-api.apifactory.md) for the
-[ErrorApi](../reference/core-plugin-api.errorapi.md):
+[`ApiFactory`](../reference/core-plugin-api.apifactory.md) for the
+[`ErrorApi`](../reference/core-plugin-api.errorapi.md):
 
 ```ts
 createApiFactory({
@@ -93,25 +93,25 @@ createApiFactory({
 });
 ```
 
-In this example the [errorApiRef](../reference/core-plugin-api.errorapiref.md)
+In this example the [`errorApiRef`](../reference/core-plugin-api.errorapiref.md)
 is our API, which encapsulates the
-[ErrorApi](../reference/core-plugin-api.errorapi.md) type. The
-[alertApiRef](../reference/core-plugin-api.alertapiref.md) is our single
+[`ErrorApi`](../reference/core-plugin-api.errorapi.md) type. The
+[`alertApiRef`](../reference/core-plugin-api.alertapiref.md) is our single
 dependency, which we give the name `alertApi`, and is then passed on to the
 factory function, which returns an implementation of the
-[ErrorApi](../reference/core-plugin-api.errorapi.md).
+[`ErrorApi`](../reference/core-plugin-api.errorapi.md).
 
-The [createApiFactory](../reference/core-plugin-api.createapifactory.md)
+The [`createApiFactory`](../reference/core-plugin-api.createapifactory.md)
 function is a thin wrapper that enables TypeScript type inference. You may
 notice that there are no type annotations in the above example, and that is
 because we're able to infer all types from the
-[ApiRef](../reference/core-plugin-api.apiref.md)s. TypeScript will make sure
+[`ApiRef`](../reference/core-plugin-api.apiref.md)s. TypeScript will make sure
 that the return value of the `factory` function matches the type embedded in
-`api`'s [ApiRef](../reference/core-plugin-api.apiref.md), in this case the
-[ErrorApi](../reference/core-plugin-api.errorapi.md). It will also match the
+`api`'s [`ApiRef`](../reference/core-plugin-api.apiref.md), in this case the
+[`ErrorApi`](../reference/core-plugin-api.errorapi.md). It will also match the
 types between the `deps` and the parameters of the `factory` function, again
 using the type embedded within the
-[ApiRef](../reference/core-plugin-api.apiref.md)s.
+[`ApiRef`](../reference/core-plugin-api.apiref.md)s.
 
 ## Registering API Factories
 
@@ -123,27 +123,27 @@ app, and the app itself.
 
 Starting with the Backstage core library, it provides implementations for all of
 the core APIs. The core APIs are the ones exported by
-[@backstage/core-plugin-api](../reference/core-plugin-api.md), such as the
-[errorApiRef](../reference/core-plugin-api.errorapiref.md) and
-[configApiRef](../reference/core-plugin-api.configapiref.md).
+[`@backstage/core-plugin-api`](../reference/core-plugin-api.md), such as the
+[`errorApiRef`](../reference/core-plugin-api.errorapiref.md) and
+[`configApiRef`](../reference/core-plugin-api.configapiref.md).
 
 The core APIs are loaded for any app created with
-[createApp](../reference/app-defaults.createapp.md) from
-[@backstage/core-plugin-api](../reference/app-defaults.md), which means that
+[`createApp`](../reference/app-defaults.createapp.md) from
+[`@backstage/core-plugin-api`](../reference/app-defaults.md), which means that
 there is no step that needs to be taken to include these APIs in an app.
 
 ### Plugin APIs
 
 In addition to the core APIs, plugins can define and export their own APIs.
 While doing so they should usually also provide default implementations of their
 own APIs, for example, the `catalog` plugin exports `catalogApiRef`, and also
-supplies a default [ApiFactory](../reference/core-plugin-api.apifactory.md) of
+supplies a default [`ApiFactory`](../reference/core-plugin-api.apifactory.md) of
 that API using the `CatalogClient`. There is one restriction to plugin-provided
 API Factories: plugins may not supply factories for core APIs, trying to do so
 will cause the app to refuse to start.
 
 Plugins supply their APIs through the `apis` option of
-[createPlugin](../reference/core-plugin-api.createplugin.md), for example:
+[`createPlugin`](../reference/core-plugin-api.createplugin.md), for example:
 
 ```ts
 export const techdocsPlugin = createPlugin({
@@ -168,7 +168,7 @@ Lastly, the app itself is the final point where APIs can be added, and what has
 the final say in what APIs will be loaded at runtime. The app may override the
 factories for any of the core or plugin APIs, with the exception of the config,
 app theme, and identity APIs. These are static APIs that are tied into the
-[createApp](../reference/app-defaults.createapp.md) implementation, and
+[`createApp`](../reference/app-defaults.createapp.md) implementation, and
 therefore not possible to override.
 
 Overriding APIs is useful for apps that want to switch out behavior to tailor it
@@ -231,19 +231,19 @@ const app = createApp({
 ```
 
 Note that the above line will cause an error if `IgnoreErrorApi` does not fully
-implement the [ErrorApi](../reference/core-plugin-api.errorapi.md), as it is
+implement the [`ErrorApi`](../reference/core-plugin-api.errorapi.md), as it is
 checked by the type embedded in the
-[errorApiRef](../reference/core-plugin-api.errorapiref.md) at compile time.
+[`errorApiRef`](../reference/core-plugin-api.errorapiref.md) at compile time.
 
 ## Defining custom Utility APIs
 
 Plugins are free to define their own Utility APIs. Simply define the TypeScript
 interface for the API, and create an
-[ApiRef](../reference/core-plugin-api.apiref.md) using
-[createApiRef](../reference/core-plugin-api.createapiref.md) exported from
-[@backstage/core-plugin-api](../reference/core-plugin-api.md). Also be sure to
+[`ApiRef`](../reference/core-plugin-api.apiref.md) using
+[`createApiRef`](../reference/core-plugin-api.createapiref.md) exported from
+[`@backstage/core-plugin-api`](../reference/core-plugin-api.md). Also be sure to
 provide at least one implementation of the API, and to declare a default factory
-for the API in [createPlugin](../reference/core-plugin-api.createplugin.md).
+for the API in [`createPlugin`](../reference/core-plugin-api.createplugin.md).
 
 Custom Utility APIs can be either public or private, which is up to the plugin
 to choose. Private APIs do not expose an external API surface, and it's
@@ -255,16 +255,16 @@ backwards compatibility of public APIs, as you may otherwise break apps that are
 using your plugin.
 
 To make an API public, simply export the
-[ApiRef](../reference/core-plugin-api.apiref.md) of the API, and any associated
+[`ApiRef`](../reference/core-plugin-api.apiref.md) of the API, and any associated
 types. To make an API private, just avoid exporting the
-[ApiRef](../reference/core-plugin-api.apiref.md), but still be sure to supply a
-default factory to [createPlugin](../reference/core-plugin-api.createplugin.md).
+[`ApiRef`](../reference/core-plugin-api.apiref.md), but still be sure to supply a
+default factory to [`createPlugin`](../reference/core-plugin-api.createplugin.md).
 
 Private APIs are useful for plugins that want to depend on other APIs outside of
 React components, but not have to expose an entire API surface to maintain. When
 using private APIs, it is fine to use the `typeof` of an implementing class as
 the type parameter passed to
-[createApiRef](../reference/core-plugin-api.createapiref.md), while public APIs
+[`createApiRef`](../reference/core-plugin-api.createapiref.md), while public APIs
 should always define a separate TypeScript interface type.
 
 Plugins may depend on APIs from other plugins, both in React components and as
@@ -273,13 +273,13 @@ dependencies between plugins.
 
 ## Architecture
 
-The [ApiRef](../reference/core-plugin-api.apiref.md) instances mentioned above
+The [`ApiRef`](../reference/core-plugin-api.apiref.md) instances mentioned above
 provide a point of indirection between consumers and producers of Utility APIs.
 It allows for plugins and components to depend on APIs in a type-safe way,
 without having a direct reference to a concrete implementation of the APIs. The
 Apps are also given a lot of flexibility in what implementations to provide. As
 long as they adhere to the contract established by an
-[ApiRef](../reference/core-plugin-api.apiref.md), they are free to choose any
+[`ApiRef`](../reference/core-plugin-api.apiref.md), they are free to choose any
 implementation they want.
 
 The figure below shows the relationship between
@@ -304,16 +304,16 @@ The indirection provided by Utility APIs also makes it straightforward to test
 components that depend on APIs, and to provide a standard common development
 environment for plugins. A proper test wrapper with mocked API implementations
 is not yet ready, but it will be provided as a part of
-[@backstage/test-utils](../reference/test-utils.md). It will provide mocked
+[`@backstage/test-utils`](../reference/test-utils.md). It will provide mocked
 variants of APIs, with additional methods for asserting a component's
 interaction with the API.
 
 The common development environment for plugins is included in
-[@backstage/dev-utils](../reference/dev-utils.md), where the exported
-[createDevApp](../reference/dev-utils.createdevapp.md) function creates an
+[`@backstage/dev-utils`](../reference/dev-utils.md), where the exported
+[`createDevApp`](../reference/dev-utils.createdevapp.md) function creates an
 application with implementations for all core APIs already present. Contrary to
 the method for wiring up Utility API implementations in an app created with
-[createApp](../reference/app-defaults.createapp.md),
-[createDevApp](../reference/dev-utils.createdevapp.md) uses automatic dependency
+[`createApp`](../reference/app-defaults.createapp.md),
+[`createDevApp`](../reference/dev-utils.createdevapp.md) uses automatic dependency
 injection. This is to make it possible to replace any API implementation, and
 having that be reflected in dependents of that API.

docs/architecture-decisions/adr003-avoid-default-exports.md

@@ -15,7 +15,7 @@ thing well". The module would be consumed
 (`const localName = require('the-module');`) without having to know the internal
 structure.
 
-Now, ESModules are the primary authoring format. They have numerous benefits,
+Now, `ESModules` are the primary authoring format. They have numerous benefits,
 such as compile-time verification of exports, and standards-defined semantics.
 They have a similar mechanism known as "default exports", which allows for a
 consumer to `import localName from 'the-module';`. This is implicitly the same

docs/architecture-decisions/index.md

@@ -34,5 +34,5 @@ Records should be stored under the `architecture-decisions` directory.
 
 ## Superseding an ADR
 
-If an ADR supersedes an older ADR then the older ADR's status is changed to
-superseded by ADR-XXXX and links to the new ADR.
+If an ADR supersedes an older ADR then the status of the older ADR is changed to
+"superseded by ADR-XXXX", and links to the new ADR.

docs/auth/gitlab/provider.md

@@ -18,7 +18,7 @@ Settings for local development:
 
 - Name: Backstage (or your custom app name)
 - Redirect URI: `http://localhost:7007/api/auth/gitlab/handler/frame`
-- Scopes: read_user
+- Scopes: `read_user`
 
 ## Configuration
 

docs/conf/defining.md

@@ -138,7 +138,7 @@ may need to pass in all files using one or multiple `--config <path>` options.
 > to change for different deployment environments should be static
 > configuration, while it should otherwise be avoided.
 
-When defining configuration for your plugin, keep keys camelCased and stick to
+When defining configuration for your plugin, keep keys on `camelCase` form and stick to
 existing casing conventions such as `baseUrl` rather than `baseURL`.
 
 It is also usually best to prefer objects over arrays, as it makes it possible