From 35f3bbb4bec1f72d8f67b71e2533d6cd52c85e26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Thu, 13 Nov 2025 12:04:59 +0100 Subject: [PATCH] Fix all current docs quality script warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/eighty-mails-leave.md | 2 +- .changeset/heavy-cars-wash.md | 8 ++++---- .changeset/warm-carrots-lead.md | 2 +- .github/vale/config/vocabularies/Backstage/accept.txt | 3 +++ contrib/docs/tutorials/heroku-deployment.md | 2 +- docs/api/deprecations.md | 2 +- plugins/home/README.md | 4 ++-- 7 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.changeset/eighty-mails-leave.md b/.changeset/eighty-mails-leave.md index 3c6ec5ab8f..e8266f6459 100644 --- a/.changeset/eighty-mails-leave.md +++ b/.changeset/eighty-mails-leave.md @@ -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 diff --git a/.changeset/heavy-cars-wash.md b/.changeset/heavy-cars-wash.md index 87da5a6d95..f3f80d9cc8 100644 --- a/.changeset/heavy-cars-wash.md +++ b/.changeset/heavy-cars-wash.md @@ -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. diff --git a/.changeset/warm-carrots-lead.md b/.changeset/warm-carrots-lead.md index fdc84d026a..81a254a6a3 100644 --- a/.changeset/warm-carrots-lead.md +++ b/.changeset/warm-carrots-lead.md @@ -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. diff --git a/.github/vale/config/vocabularies/Backstage/accept.txt b/.github/vale/config/vocabularies/Backstage/accept.txt index 80d55d498a..7c780c1079 100644 --- a/.github/vale/config/vocabularies/Backstage/accept.txt +++ b/.github/vale/config/vocabularies/Backstage/accept.txt @@ -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 diff --git a/contrib/docs/tutorials/heroku-deployment.md b/contrib/docs/tutorials/heroku-deployment.md index 2dea1f021c..8d0b8740b7 100644 --- a/contrib/docs/tutorials/heroku-deployment.md +++ b/contrib/docs/tutorials/heroku-deployment.md @@ -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 diff --git a/docs/api/deprecations.md b/docs/api/deprecations.md index a9127426f0..84c0300543 100644 --- a/docs/api/deprecations.md +++ b/docs/api/deprecations.md @@ -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 diff --git a/plugins/home/README.md b/plugins/home/README.md index b08e785403..242e66ff40 100644 --- a/plugins/home/README.md +++ b/plugins/home/README.md @@ -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 {