docs: Fix typos

Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com>
This commit is contained in:
Gabriel Dugny
2025-04-18 17:03:01 +02:00
parent 222b18a67f
commit 14bddfd10f
20 changed files with 28 additions and 26 deletions
@@ -13,7 +13,7 @@ it also defines what authentication metadata about a Kubernetes cluster is retur
## Context
Backstage includes by default some [Kubernetes Auth Providers](./authentication.md) to ease the authentication proccess to
Backstage includes by default some [Kubernetes Auth Providers](./authentication.md) to ease the authentication process to
kubernetes clusters, it includes:
- `Server Side Providers` like `localKubectlProxy` or `serviceAccount` where the same set
+1 -1
View File
@@ -29,7 +29,7 @@ On the user experience side, a Backstage experience without complete organizatio
While it's possible to get hold of a catalog client via the `catalogServiceRef` from `@backstage/plugin-catalog-node`, it's almost never the right thing to do, and we strongly discourage from doing so.
The catalog processing loop is a very high-speed system where your entire catalog cluster collaborates to race through all entities at the highest possible rate. The ideal processor does an absolute minimum of work, and immediately relinquishes control back. Performing asynchronous requests to external systems - including the catalog - from processors, can quickly become overwhelming for that external system and starve their resources if they aren't prepared to deal with very high rates of small requests. It also significantly slows down the procesing loop, when each step needs to wait for responses. This can lead to work "piling up" in the catalog and delays in seeing entities get updated. The [life of an entity](./life-of-an-entity.md) article shows the sequence of events that happen when an entity goes from original ingestion, through processing, and to becoming final entities.
The catalog processing loop is a very high-speed system where your entire catalog cluster collaborates to race through all entities at the highest possible rate. The ideal processor does an absolute minimum of work, and immediately relinquishes control back. Performing asynchronous requests to external systems - including the catalog - from processors, can quickly become overwhelming for that external system and starve their resources if they aren't prepared to deal with very high rates of small requests. It also significantly slows down the processing loop, when each step needs to wait for responses. This can lead to work "piling up" in the catalog and delays in seeing entities get updated. The [life of an entity](./life-of-an-entity.md) article shows the sequence of events that happen when an entity goes from original ingestion, through processing, and to becoming final entities.
See also [the related validation topic](#can-i-validate-relations-in-processors).
@@ -118,7 +118,7 @@ export const mockDecorator = createScaffolderFormDecorator({
// give the decorator a name
id: 'mock-decorator',
// define the schema for the input that can be proided in `template.yaml`
// define the schema for the input that can be provided in `template.yaml`
schema: {
input: {
test: z => z.string(),
@@ -151,7 +151,7 @@ const routes = (
### Async Validation Function
A validation function can be asyncronous and use [Utility APIs](https://backstage.io/docs/api/utility-apis/) via the `ApiHolder` in the [field validation context](https://backstage.io/docs/reference/plugin-scaffolder-react.customfieldvalidator). The example below uses the `catalogApiRef` to check if the submitted value (in this scenario an entity ref) exists in the catalog.
A validation function can be asynchronous and use [Utility APIs](https://backstage.io/docs/api/utility-apis/) via the `ApiHolder` in the [field validation context](https://backstage.io/docs/reference/plugin-scaffolder-react.customfieldvalidator). The example below uses the `catalogApiRef` to check if the submitted value (in this scenario an entity ref) exists in the catalog.
```tsx
import { FieldValidation } from '@rjsf/utils';
@@ -252,7 +252,7 @@ spec:
type: service
parameters:
- title: Authenticaion
- title: Authentication
description: Provide authentication for the resource
required:
- username
+1 -1
View File
@@ -934,7 +934,7 @@ metadata:
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: example-platfrom
name: example-platform
title: Example Application Platform
namespace: default
description: This is the child entity