Merge pull request #31746 from backstage/freben/docsq
🧹 Fix all current docs quality script warnings
This commit is contained in:
@@ -2,4 +2,4 @@
|
||||
'@backstage/plugin-home': patch
|
||||
---
|
||||
|
||||
Allow customization of VisitList by adding optional enrichVisit, transformPathname, canSave functions to VisitsStorageApi, along with VisitDisplayProvider for colors, labels
|
||||
Allow customization of `VisitList` by adding optional `enrichVisit`, `transformPathname`, `canSave` functions to `VisitsStorageApi`, along with `VisitDisplayProvider` for colors, labels
|
||||
|
||||
@@ -8,8 +8,8 @@ Moved from `ldapjs` dependency to `ldapts`
|
||||
|
||||
**Type Migration**
|
||||
|
||||
Custom transformers must now accept `Entry` from ldapts instead of `SearchEntry`
|
||||
from ldapjs The Entry type provides direct property access without need for
|
||||
Custom transformers must now accept `Entry` from `ldapts` instead of `SearchEntry`
|
||||
from `ldapjs` The Entry type provides direct property access without need for
|
||||
`.object()` or `.raw()` methods.
|
||||
|
||||
If you have custom user or group transformers, update the signature from:
|
||||
@@ -29,7 +29,7 @@ to
|
||||
**Search Options**
|
||||
|
||||
Updated LDAP search configuration `typesOnly: false` → `attributeValues: true`
|
||||
This inverts the boolean logic: ldapjs used negative form while ldapts uses
|
||||
This inverts the boolean logic: `ldapjs` used negative form while `ldapts` uses
|
||||
positive form. Both achieve the same result: retrieving attribute values rather
|
||||
than just attribute names.
|
||||
|
||||
@@ -66,5 +66,5 @@ for (const entry of entries) {
|
||||
```
|
||||
|
||||
> **_NOTE:_**: Both methods have always loaded all entries into memory. The
|
||||
> searchStreaming method was only needed internally to handle ldapjs's
|
||||
> `searchStreaming` method was only needed internally to handle `ldapjs`'s
|
||||
> event-based API.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
'@backstage/ui': patch
|
||||
---
|
||||
|
||||
Fixed Table Row component to properly support opening links in new tabs via right-click or Cmd+Click when using the href prop.
|
||||
Fixed Table Row component to properly support opening links in new tabs via right-click or Cmd+Click when using the `href` prop.
|
||||
|
||||
@@ -59,6 +59,7 @@ Chanwit
|
||||
CI/CD
|
||||
classname
|
||||
cli
|
||||
CLIs
|
||||
cloudbuild
|
||||
Cloudflare
|
||||
Cloudformation
|
||||
@@ -149,6 +150,7 @@ etag
|
||||
Expedia
|
||||
facto
|
||||
failover
|
||||
faq
|
||||
Fargate
|
||||
faqs
|
||||
featureful
|
||||
@@ -325,6 +327,7 @@ onboarded
|
||||
onboarding
|
||||
Onboarding
|
||||
onelogin
|
||||
openapi
|
||||
OpenSearch
|
||||
OpenShift
|
||||
openssl
|
||||
|
||||
@@ -49,7 +49,7 @@ Add a build script in `package.json` to compile frontend during deployment:
|
||||
|
||||
## Start Command
|
||||
|
||||
Create a [Procfile](https://devcenter.heroku.com/articles/procfile) in the app's root:
|
||||
Create a [`Procfile`](https://devcenter.heroku.com/articles/procfile) in the app's root:
|
||||
|
||||
```shell
|
||||
echo "web: yarn workspace backend start --config ../../app-config.yaml --config ../../app-config.production.yaml" > Procfile
|
||||
|
||||
@@ -124,7 +124,7 @@ createApiFactory({
|
||||
```
|
||||
|
||||
Provider specific factory implementations, copy the code you need into the
|
||||
factory method depending on which apiRef you previously used.
|
||||
factory method depending on which API ref you previously used.
|
||||
|
||||
```ts
|
||||
// samlAuthApiRef
|
||||
|
||||
@@ -358,7 +358,7 @@ In order to validate the config you can use `backstage/cli config:check`
|
||||
|
||||
### Customizing the VisitList
|
||||
|
||||
If you want more control over the recent and top visited lists, you can write your own functions to transform the pathnames and determine which visits to save. You can also enrich each visit with other fields and customize the chip colors/labels in the visit lists.
|
||||
If you want more control over the recent and top visited lists, you can write your own functions to transform the path names and determine which visits to save. You can also enrich each visit with other fields and customize the chip colors/labels in the visit lists.
|
||||
|
||||
#### Transform Pathname Function
|
||||
|
||||
@@ -490,7 +490,7 @@ export const apis: AnyApiFactory[] = [
|
||||
|
||||
#### Custom Chip Colors and Labels
|
||||
|
||||
To provide your own chip colors and/or labels for the recent and top visited lists, wrap the components in `VisitDisplayProvider` with `getChipColor` and `getChipLabel` functions. The colors provided will be used instead of the hard coded [colorVariants](https://github.com/backstage/backstage/blob/2da352043425bcab4c4422e4d2820c26c0a83382/packages/theme/src/base/pageTheme.ts#L46) provided via `@backstage/theme`.
|
||||
To provide your own chip colors and/or labels for the recent and top visited lists, wrap the components in `VisitDisplayProvider` with `getChipColor` and `getChipLabel` functions. The colors provided will be used instead of the hard coded [`colorVariants`](https://github.com/backstage/backstage/blob/2da352043425bcab4c4422e4d2820c26c0a83382/packages/theme/src/base/pageTheme.ts#L46) provided via `@backstage/theme`.
|
||||
|
||||
```tsx
|
||||
import {
|
||||
|
||||
Reference in New Issue
Block a user