Commit Graph

6896 Commits

Author SHA1 Message Date
Aramis Sennyey 722b35e1a4 docs: use accordions for common issues in golden-path (#33840)
* fix: use accordions for common issues

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix code block

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2026-04-13 10:23:44 -04:00
Patrik Oldsberg b9b7862418 Merge pull request #33854 from alliasgher/docs-add-app-visualizer-details
docs: expand app-visualizer plugin documentation in migration guide
2026-04-13 10:01:18 +02:00
Ali c336308f65 docs: expand app-visualizer plugin documentation in migration guide
Add detailed usage documentation for the app-visualizer plugin in the
troubleshooting section of the migration guide. Includes installation
steps, descriptions of all three views (Tree, Detailed, Text), and
practical guidance for using the plugin during migration.

Closes #32715

Signed-off-by: Ali <ali@kscope.ai>
2026-04-13 04:58:47 +05:00
Patrik Oldsberg 53954e1199 permission-react: remove deprecated PermissionedRoute component
Removed the deprecated `PermissionedRoute` component that was incompatible
with React Router v6 stable. Use `RequirePermission` instead.

Also removed the `react-router-dom` dependency from the package since it
is no longer needed.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-13 00:40:12 +02:00
Andre Wanlin a52a2236d4 Merge pull request #33808 from meleu/patch-3
Update TechDocs CLI repo link, as the old repo was archived in 2021
2026-04-11 15:18:43 -05:00
Aramis Sennyey 2b4f97adf7 docs: frontend plugin golden path (#33541)
* docs: frontend plugin golden path guide

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* add changeset

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* Apply suggestion from @aramissennyeydd

Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix template

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix template test

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* print stderr on failure

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* try writing directly

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* maybe this?

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* address feedback

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix: avoid destructuring FetchApi and fix template issues

- Use fetchApi.fetch() instead of destructuring to preserve this binding
- Add discoveryApi and fetchApi to useAsync dependency array
- Use react-use/esm/useAsync to match repo conventions
- Replace waitFor + getAllByText with findByText in error test
- Update HTTP client doc to match template changes

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix: address docs review feedback

- Use stronger guidance tone in scaffolding guide intro
- Slim down file tree to show folder structure only
- Mention that plugin path depends on chosen plugin ID
- Link to installation docs for non-discovery case
- Quote page:todo YAML key to avoid parse errors
- Remove "new" from "new frontend system" in template README

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix: improve error handling in e2e plugin creation

- Narrow error to non-null object before using in operator
- Also write error.stdout since tools like Jest report to stdout
- Avoid variable shadowing with outer scope stdout/stderr

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* revert: keep destructured fetch from FetchApi

Destructuring fetch from FetchApi is fine — revert to original
pattern while keeping the dependency array and other fixes.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* feat: use @backstage/ui components in frontend plugin template

Replace core-components layout and table with @backstage/ui equivalents:
- Use HeaderPage and Container instead of Page, Header, Content, ContentHeader
- Use BUI Table with useTable and CellText instead of core-components Table
- Add @backstage/ui to template package.json dependencies
- Update poking-around docs to reflect BUI component usage

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix: add example data when backend request fails

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* better logging setup

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* address feedback

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* better config driven example

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* debug logs

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix build failure related to unknown version

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* revert e2e run changes

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

* skip the discovery api for now

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* remove another ref

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-04-10 14:00:55 -04:00
Hellgren Heikki 4c1fd438b3 feat(notifications): action to get users notifications
useful for mcp for example to get the daily what is going on
status.

Signed-off-by: Hellgren Heikki <heikki.hellgren@op.fi>
2026-04-10 10:19:46 +03:00
Andre Wanlin eb8a6f7291 Merge pull request #33346 from awanlin/create-app/mcp-actions
create-app - Added the `mcp-actions-backend` and the `plugin-auth` plugins
2026-04-09 08:48:17 -05:00
Andre Wanlin 72a493a56a create-app - Added the mcp-actions-backend plugin
Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Changes based on feedback

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Minor corrections

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Default to false

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Corrections

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Feedback

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Feedback changes

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Feedback changes

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Added tip

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

More feedback changes

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Fixed typos

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Reorder auth

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-04-09 08:33:59 -05:00
Claire Peng d4979b5178 add note about API Base URL in descriptor-format docs page
Signed-off-by: Claire Peng <clairep@spotify.com>
2026-04-09 10:57:56 +01:00
Patrik Oldsberg 814f61a526 Merge pull request #33767 from EoinTrial/docs/i18n-available-languages
docs: document availableLanguages and defaultLanguage for i18n in new frontend system
2026-04-09 01:30:41 +02:00
Andre Wanlin 6c6fbe207a Update docs/features/techdocs/troubleshooting.md
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2026-04-08 11:56:08 -05:00
meleu 7da6368a72 Fix TechDocs CLI link
Updated TechDocs CLI link to point to the correct repository, as the old one is now archived.

Signed-off-by: meleu <meleu@users.noreply.github.com>
2026-04-08 13:04:04 -03:00
Patrik Oldsberg 1e8899a65f Merge pull request #33705 from schultzp2020/remove-jsx-codemod-guide
docs: replace JSX codemod tutorial with link to codemod.com
2026-04-07 20:33:47 +02:00
github-actions[bot] 6c10d88c13 Version Packages (next) 2026-04-07 15:30:58 +00:00
Patrik Oldsberg 8632502abe Merge pull request #33436 from jonkoops/remove-legacy-proxy-docs
docs: remove legacy corporate proxy documentation
2026-04-07 16:30:05 +02:00
Fredrik Adelöw 587981973c Merge pull request #33576 from backstage/maratd/replace-humanize-entity-ref
Replace deprecated humanizeEntityRef with Catalog Presentation API
2026-04-07 14:28:39 +02:00
Marat Dyatko b32ab39670 Fix unsafe type casts via shared entityPresentationSnapshot utility
Extract entityPresentationSnapshot helper to eliminate unsafe `as Entity`
casts when passing CompoundEntityRef to EntityPresentationApi.forEntity(),
which only accepts Entity | string. The helper safely discriminates input
types and stringifies CompoundEntityRef before calling the API.

- Add entityPresentationSnapshot as a public export from catalog-react
- Remove duplicated getEntityTitle/getTitle helpers across 5 files
- Fix useAsync dependency array in TemplateFormPreviewer
- Update TSDoc across all presentation API surfaces to reference the
  new helper
- Update entity-presentation.md docs with usage guidance and migration
  table

Made-with: Cursor
Signed-off-by: Marat Dyatko <maratd@spotify.com>
2026-04-07 12:41:29 +02:00
Patrik Oldsberg 9718e62c2d Merge pull request #33667 from backstage/docs-features-new-frontend-migration
docs: migrate feature documentation to new frontend system as primary content
2026-04-07 12:01:07 +02:00
Eoin Shaughnessy 8b997d07c4 docs: address review feedback on i18n available languages section
Signed-off-by: Eoin Shaughnessy <eoinsh@gmail.com>
2026-04-05 23:56:19 +01:00
Eoin Shaughnessy 6aed2dcab1 docs: document availableLanguages and defaultLanguage for i18n in new frontend system
Signed-off-by: Eoin Shaughnessy <eoinsh@gmail.com>
2026-04-05 23:42:19 +01:00
Patrik Oldsberg d8976ea648 Merge pull request #33723 from Parsifal-M/docs/update-fe-migration-skill
Edit the SubPageBluepring instructions section
2026-04-05 22:11:52 +02:00
Patrik Oldsberg 5c9b621ffb Merge pull request #33760 from backstage/rugvip/parter-cleanup
docs: update commercial partners and FAQ
2026-04-05 21:59:29 +02:00
Patrik Oldsberg 76fdf2cb31 docs: update FAQ about commercial Backstage offerings
Update the question about hosted/commercial versions of Backstage
to be vendor-neutral and link to the commercial partners page.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-05 19:38:20 +02:00
Patrik Oldsberg b592810c5f Fix duplicate frontmatter IDs in old-system doc pages
Prefix the frontmatter `id` in the --old variants with their
feature area (techdocs-/search-) so Docusaurus no longer reports
duplicate doc ID collisions.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-04 23:51:04 +02:00
Patrik Oldsberg 7f6b88783b docs: address review feedback on route refs, typos, and installation steps
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-04 16:15:01 +02:00
Patrik Oldsberg fb571af4ee fix: correct broken doc links in search getting-started guides
Update links to removed how-to-guides anchors (#how-to-index-techdocs-documents
and #how-to-limit-what-can-be-searched-in-the-software-catalog) to point to the
existing #how-to-customize-fields-in-the-software-catalog-or-techdocs-index
anchor instead. Also update the old frontend system guide to link to the
--old variants of how-to-guides.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-04 12:47:25 +02:00
Patrik Oldsberg 18fde07e06 docs: address review feedback on code style in examples
Replace `Promise.resolve(...)` with `async` functions in scaffolder
FormFieldBlueprint.make examples, and switch the TechDocs custom home
page example to use the `plugin.withOverrides` pattern instead of
`createFrontendModule`.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-04 12:34:50 +02:00
Andre Wanlin 8bf97618ee Fixed links
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-04-03 12:39:28 -05:00
Andre Wanlin 6e6eff9b90 Fixes
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-04-03 12:28:56 -05:00
Andre Wanlin 5cbd39e980 Clean up of the contrib folder
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-04-03 12:28:53 -05:00
Patrik Oldsberg a4b9c45277 Merge pull request #33054 from StateFarmIns/theme-fix-mui-5-class-name-prefix
fix: MUI 5 v5- class name prefix reliability
2026-04-03 19:15:45 +02:00
Patrik Oldsberg 8f9c1d64b8 verify-links: catch broken anchors, directory links, and invisible characters (#33713)
* verify-links: catch broken anchors, directory links, and invisible characters

Enhances the link verification script to catch several categories of
broken links that were previously missed:

- Broken anchors (cross-file and same-file) by extracting heading slugs
  from target documents and verifying anchors resolve
- Directory links missing index.md suffix within docs/
- Invisible/zero-width characters in URLs
- Case-sensitive anchor mismatches

Also strips fenced code blocks before scanning for links to avoid false
positives, and handles duplicate heading slug deduplication (GitHub and
Docusaurus append -1, -2, etc.).

Fixes a few newly-caught broken links in existing docs.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor

* Fix CodeQL incomplete multi-character sanitization alert

Apply HTML tag stripping in a loop so that nested fragments
like <scr<script>ipt> are fully removed.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor

---------

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-04-03 17:48:40 +02:00
Rajib Quayum 452bb50432 chore: fix documentation
Signed-off-by: Rajib Quayum <rajibq@users.noreply.github.com>
2026-04-03 10:30:00 -04:00
Rajib Quayum e22fc0af9c chore: update docs for MUI v5 class name prefix issue
Signed-off-by: Rajib Quayum <rajibq@users.noreply.github.com>
2026-04-03 10:01:25 -04:00
Peter Macdonald a7859cf2dc phrasing
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-04-02 10:46:47 +02:00
Peter Macdonald 7f688e5e8f re-word the subpageblueprint section a bit
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-04-02 10:44:00 +02:00
Peter Macdonald af968456de Merge pull request #33700 from Parsifal-M/docs/update-fe-skill
docs: Update FE migration skill
2026-04-01 09:35:57 +02:00
Fredrik Adelöw 49efae88e4 Merge pull request #33704 from backstage/freben/fix-docs-broken-links
docs: fix broken links and anchors across documentation
2026-04-01 09:02:46 +02:00
Paul Schultz 2072182904 docs: replace JSX codemod tutorial with link to codemod.com
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2026-03-31 15:32:54 -05:00
Fredrik Adelöw bb7768ba06 docs: fix broken links and anchors across documentation
Fix ~30 broken links and anchors across the documentation site, including
incorrect relative paths, mismatched anchor names, zero-width characters
in URLs, and references to renamed or removed headings.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Fredrik Adelöw <freben@spotify.com>
2026-03-31 18:43:40 +02:00
github-actions[bot] a2cb332e25 Version Packages (next) 2026-03-31 15:30:51 +00:00
Peter Macdonald 4a1b7f228d update wording
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-31 13:30:00 +02:00
Peter Macdonald a3c65c8e2a add a note about the backstage version in the fe-migration skill
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-31 13:27:17 +02:00
Hellgren Heikki 8435ce9a81 docs(ai): add skills documentation
based on the BEP-0013 add the necessary docs for using and
contributing AI skills

Signed-off-by: Hellgren Heikki <heikki.hellgren@op.fi>
2026-03-31 07:59:05 +03:00
Fredrik Adelöw a1f6de6ac0 Merge pull request #33678 from milliehartnt123/milliehartnt123-modify-graphics-update-comp
Fix repository name and owner in graphics
2026-03-30 22:52:20 +02:00
milliehartnt123 a9d22e1acd Fix repository name and owner in graphics
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2026-03-30 13:22:07 -04:00
Patrik Oldsberg f48e496e65 Merge pull request #33668 from backstage/docs-auth-oidc-new-frontend
docs: migrate OIDC auth docs to new frontend system
2026-03-30 17:42:42 +02:00
Patrik Oldsberg 19b3196c67 docs: fix Prettier formatting in OIDC auth docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 17:26:29 +02:00
Patrik Oldsberg bf1eb45609 Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-03-30 17:14:00 +02:00