paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

Fixes grammar in api docs

Browse Source 
Signed-off-by: mischievous007 <aditya.kr1693@gmail.com>
This commit is contained in:
mischievous007
2024-09-30 09:26:16 +05:30
parent 416d16795b
commit 60403a86b8
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/deprecations.md
+3 -3
View File
@@ -26,7 +26,7 @@ opens up for other type of themes, and removes the hardcoded usage of
To migrate an existing theme, remove the `theme` property and move it over to a
new `Provider` component, using `ThemeProvider` from Material UI to provide the new
theme, along with `<CssBaseline>`. For example a theme that currently looks like
theme, along with `<CssBaseline>`. For example, a theme that currently looks like
this:
```tsx
@@ -84,7 +84,7 @@ migrate to your own custom API.
First, you'll need to define a new Utility API reference. If you're only using
the API for sign-in, you can put the definition in `packages/app/src/apis.ts`.
However, if you need to access your auth API inside plugins you you'll need to
export it from a common package. If you don't already have one we recommended
export it from a common package. If you don't already have one, we recommended
creating `@internal/apis` and from there export the API reference.
```ts
@@ -101,7 +101,7 @@ export const acmeAuthApiRef: ApiRef<
});
```
Next you'll want to wire up the API inside `packages/app/src/apis.ts`, which
Next, you'll want to wire up the API inside `packages/app/src/apis.ts`, which
varies depending on which API you're replacing. If you for example are replacing
the `oauth2ApiRef`, the factory might look like this:
docs/api/utility-apis.md
+2 -2
View File
@@ -166,10 +166,10 @@ 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
therefore not possible to override.
therefore, not possible to override.
Overriding APIs is useful for apps that want to switch out behavior to tailor it
to their environment. In some cases plugins, may also export multiple
to their environment. In some cases, plugins may also export multiple
implementations of the same API, where they each have their own different
requirements, for example, backend storage and the surrounding environment.