Commit Graph

6896 Commits

Author SHA1 Message Date
Patrik Oldsberg 26537124e0 Merge pull request #33665 from backstage/rugvip/docs-notifications-new-frontend
docs: migrate notifications docs to new frontend system
2026-03-30 16:42:19 +02:00
Patrik Oldsberg 014ba202ba Merge pull request #33670 from backstage/rugvip/app-routes-redirect-config
plugin-app: add redirect config to app/routes extension
2026-03-30 16:40:37 +02:00
Patrik Oldsberg 6cabf73736 Merge pull request #33669 from backstage/rugvip/docs-getting-started-new-frontend
docs: migrate getting-started docs to new frontend system
2026-03-30 14:40:34 +02:00
Patrik Oldsberg 0f8b40ddc5 docs: address copilot review comments
Add installation example for extraIcons in the customize-theme guide
and fix "productional code" typo in quickstart-app-plugin--old.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 12:57:47 +02:00
Patrik Oldsberg 88296d5d33 docs: pass auth environment in OAuth2.create example
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 12:48:01 +02:00
Patrik Oldsberg c38a71f855 docs: migrate OIDC auth docs to new frontend system
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 12:45:05 +02:00
Patrik Oldsberg 561f555fb1 docs: address copilot review feedback
Fix links in viewing-catalog.md and filter-catalog.md to point to
the new frontend system catalog-customization.md instead of the old
guide. Fix the Kubernetes entity content extension ID to use the
correct `entity-content:kubernetes/kubernetes` format. Wrap raw
extension definitions in `createFrontendModule` in search and
scaffolder docs. Correct TechDocs addon installation instructions
to explicitly install addon modules rather than claiming
auto-discovery.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 12:42:11 +02:00
Patrik Oldsberg 89e3f98fa1 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 12:39:13 +02:00
Patrik Oldsberg 769fa96fe8 docs: address review feedback on notifications docs
Use dynamic import pattern for SubPageBlueprint loader instead of
Promise.resolve, and fix missing comma in TypeScript example.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 12:36:27 +02:00
Patrik Oldsberg 964e8f9779 Update docs/notifications/index--old.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-03-30 12:30:11 +02:00
Patrik Oldsberg b70d3ca1ab Update docs/notifications/index.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-03-30 12:30:04 +02:00
Fredrik Adelöw d3b8c370e1 Update docs/tooling/cli/03-commands.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2026-03-30 11:53:30 +02:00
Fredrik Adelöw 6cc48113fc remove some cli deprecation warnings
Signed-off-by: Fredrik Adelöw <freben@spotify.com>
2026-03-30 09:44:30 +02:00
Patrik Oldsberg 4a01a66da3 docs: document app/routes redirect configuration
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 01:36:07 +02:00
Patrik Oldsberg c9132c223c docs: improve new frontend system docs for techdocs, scaffolder, and catalog
Expand the TechDocs home page customization section with concrete examples
showing how to override the page:techdocs extension using a frontend module.

Replace the incorrect scaffolder custom step layouts guide with a note that
this feature is not yet supported in the new frontend system.

Restore missing catalog customization docs for columns, actions, table
options, removing filters, and fully custom catalog pages to ensure parity
with the old frontend system guide.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 23:04:08 +02:00
Patrik Oldsberg 15ab64be96 docs: fix relative link depth in customize-theme guide
The previous fix overshot the directory traversal — three levels up
escapes the docs root. Use two levels (`../../`) to correctly reach the
frontend-system migration guide from golden-path/create-app/.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 22:49:58 +02:00
Patrik Oldsberg 93cb19813f fix: correct broken link to extension overrides documentation
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 22:40:19 +02:00
Patrik Oldsberg dce631e6f7 docs: fix broken relative link in customize-theme guide
Fix the relative path to the sidebar customization section in the
migration guide, which was missing two levels of directory traversal.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 22:39:53 +02:00
Patrik Oldsberg 8ec254cd4b docs: migrate feature docs to new frontend system as primary content
Rewrite documentation for TechDocs, Software Templates, Software Catalog,
Search, and Kubernetes features to use the new frontend system as the
primary installation and configuration instructions. Old frontend system
instructions are moved to separate `--old` suffixed files for pages with
substantial legacy content, or updated inline for pages with minimal
old-system content.

Files migrated:
- techdocs/getting-started.md
- techdocs/how-to-guides.md
- software-templates/writing-custom-step-layouts.md
- software-templates/writing-custom-field-extensions.md
- software-templates/index.md
- software-catalog/catalog-customization.md
- search/getting-started.md
- search/how-to-guides.md
- kubernetes/installation.md

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 21:47:46 +02:00
Patrik Oldsberg 7c1b319e74 docs: migrate getting-started docs to new frontend system
Migrate four documentation pages to use the new frontend system as the
primary content, moving the old frontend system instructions to --old
files following the established convention:

- configure-app-with-plugins: rewrite for auto-discovered plugins
- customize-theme: rewrite for ThemeBlueprint/extension-based theming
- enable-public-entry: make new frontend system the primary content
- quickstart-app-plugin: remove manual sidebar wiring instructions

Each main file gets an info banner linking to the --old variant, and
each --old file gets a banner linking back to the current guide.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 21:35:17 +02:00
Patrik Oldsberg 23f731118d docs: migrate OIDC auth docs to new frontend system
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 21:32:52 +02:00
Patrik Oldsberg 2ad2771944 docs: migrate notifications docs to new frontend system
Rewrite the notifications documentation pages to target the new
frontend system as the primary content, and move the old frontend
system instructions to --old files following the established convention.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 21:30:48 +02:00
Marat Dyatko e5af44c846 Address PR review feedback from freben
- Consolidate changesets: one for catalog-react (deprecation), one combined
  for the remaining 5 plugins
- Add entity-presentation to microsite/sidebars.ts
- Update @deprecated tags to point to useEntityPresentation /
  entityPresentationApiRef only, not defaultEntityPresentation
- Use entityPresentationApiRef with .promise in async loaders
  (StepPrepareCreatePullRequest, TemplateFormPreviewer)
- Add optional entityPresentation?: EntityPresentationApi param to sync
  column factories and use .snapshot when available
  (columnFactories, EntityTable/columns, EntityOwnerPicker, CatalogTable)
- Rewrite entity-presentation.md to recommend .snapshot/.promise instead
  of defaultEntityPresentation
- Update TSDoc on entityPresentationApiRef, EntityPresentationApi,
  defaultEntityPresentation, useEntityPresentation, EntityDisplayName
- Re-export presentation API types from alpha entry point
- Update API reports
- Fix test mocks for entityPresentationApiRef

Made-with: Cursor
Signed-off-by: Marat Dyatko <maratd@spotify.com>
Made-with: Cursor
2026-03-27 14:04:04 +01:00
Patrik Oldsberg 9e80eff573 docs: update MUI to BUI migration skill (#33548)
Update the MUI to BUI migration skill to reflect the current state
of the @backstage/ui package.


Made-with: Cursor

Made-with: Cursor

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-03-26 15:03:33 +01:00
Marat Dyatko 5f9a531412 Replace deprecated humanizeEntityRef with Catalog Presentation API
Migrate all humanizeEntityRef and humanizeEntity usages to the Catalog
Presentation API across catalog, catalog-react, org-react,
catalog-import, scaffolder, and techdocs plugins.

- Use useEntityPresentation hook in React component contexts
  (AncestryPage)
- Use defaultEntityPresentation for non-React contexts like sort
  comparators, filter functions, and data mappers
- Add @deprecated tags to humanizeEntityRef and humanizeEntity
- Improve TSDoc on entityPresentationApiRef, EntityPresentationApi,
  useEntityPresentation, EntityDisplayName, and
  defaultEntityPresentation with guidance on which to use when
- Add Entity Presentation docs page with usage examples and migration
  guide

Made-with: Cursor

Signed-off-by: Marat Dyatko <maratd@spotify.com>
2026-03-26 08:59:43 +01:00
Peter Macdonald cf4b4789f1 Merge pull request #33572 from Parsifal-M/docs/golden-paths-prep-ga
docs: golden paths prepping for GA
2026-03-25 17:52:27 +01:00
Stephanie Cao 309b7128c4 feat(scaffolder): create scaffolder mcp action to execute a template (#33124)
* create mcp action to execute a template

Signed-off-by: Stephanie <yangcao@redhat.com>

* include changeset

Signed-off-by: Stephanie <yangcao@redhat.com>

* address test errors and review comments from copilot

Signed-off-by: Stephanie <yangcao@redhat.com>

* address review comments

Signed-off-by: Stephanie <yangcao@redhat.com>

* add execute-template to mcp actions list

Signed-off-by: Stephanie <yangcao@redhat.com>

* fix: address review feedback for execute-template action

Signed-off-by: benjdlambert <ben@blam.sh>

---------

Signed-off-by: Stephanie <yangcao@redhat.com>
Signed-off-by: benjdlambert <ben@blam.sh>
Co-authored-by: benjdlambert <ben@blam.sh>
2026-03-25 16:30:49 +01:00
Peter Macdonald 1b8d4be5df reference analytics docs in prepping for ga and remove the dead links to ga from analytics plugin docs
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-25 13:56:48 +01:00
Peter Macdonald 2f88cef8f4 Merge branch 'master' into docs/golden-paths-prep-ga 2026-03-25 13:33:20 +01:00
Peter Macdonald 36d205a455 Merge pull request #33573 from Parsifal-M/docs/golden-paths-plugin-ownership
docs: golden paths plugin ownership
2026-03-25 13:18:18 +01:00
Patrik Oldsberg e7e2fb2a5a Merge pull request #33570 from backstage/rugvip/nfs-migration-skills
docs: add frontend system migration skills
2026-03-25 11:54:17 +01:00
Peter Macdonald c397a27d77 golden paths plugin ownership
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-25 11:08:48 +01:00
Patrik Oldsberg d031c9fe0f docs: fix missing import and replace deprecated HeaderPage with Header
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-25 10:52:48 +01:00
Peter Macdonald 65f3aa7c3d don't use comms use communication
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-25 10:34:33 +01:00
Peter Macdonald 1fcc30299d preparing for GA
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-25 10:27:46 +01:00
Patrik Oldsberg db7b6d1716 docs: refine skill descriptions
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-25 10:08:21 +01:00
Patrik Oldsberg fe6f4a03ab docs: add frontend system migration skills
Add three new skill documents for migrating to the new Backstage frontend system:

- App migration (old app-defaults to new frontend-defaults)
- Plugin dual-support (adding new system support while keeping old system working)
- Plugin full migration (completely moving to the new frontend system)

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-25 09:58:27 +01:00
Peter Macdonald bdd21b9f9c Merge pull request #33547 from Parsifal-M/docs/golden-path-permissions
docs: golden paths permissions
2026-03-24 22:11:36 +01:00
Peter Macdonald 6c22088daa updates based on feedback
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-24 16:13:35 +01:00
Peter Macdonald d65d6d6d50 updates based on style new style guide
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-24 16:10:35 +01:00
Peter Macdonald a8e111f9b5 Merge branch 'master' into docs/golden-path-permissions 2026-03-24 16:06:22 +01:00
github-actions[bot] c1b510cabb Version Packages (next) 2026-03-24 14:54:00 +00:00
Peter Macdonald e0209029d6 docs: update golden paths sustainable-plugin-development section (#33539)
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-24 15:47:41 +01:00
Aramis Sennyey 7f26ea88c5 docs: add documentation style guide for Backstage contributors (#33538)
* docs: add documentation style guide for Backstage contributors

Adapted from the Kubernetes documentation style guide, tailored
for the Backstage project with Backstage-specific terminology,
Docusaurus conventions, tone guidelines, and project word list.

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

* docs: soften "we" guidance and link style guide from CONTRIBUTING.md

Relax the "avoid we" rule to allow "we" in tutorials and walkthroughs
where it means "you and I, working through this together." Also add
references to the style guide from CONTRIBUTING.md and AGENTS.md.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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>

* fix link checker

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

* skip block

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

* address feedback

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.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-03-24 15:44:35 +01:00
Peter Macdonald f34dc2a6f3 update golden paths permissions section
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-24 14:48:51 +01:00
Andre Wanlin a1b8157800 Merge pull request #33173 from drodil/ai_bep
docs(bep): define shared AI assets repo and cli support
2026-03-23 12:01:27 +01:00
Jon Koops 980b7f5632 docs: remove legacy corporate proxy documentation
All Node.js versions in Backstage's support matrix (v22 and v24 LTS)
include built-in proxy support via NODE_USE_ENV_PROXY, making the
legacy global-agent/undici workarounds unnecessary. Remove the legacy
proxy guide from contrib/ and all references to the legacy approach
across the docs.

Signed-off-by: Jon Koops <jonkoops@gmail.com>
2026-03-19 17:17:17 +01:00
Hellgren Heikki 907682f945 docs(bep): define shared AI assets repo and cli support
this PR introduces BEP for backstage managed AI assets in the backstage
monorepo that can be shared with backstage contributors and adaptors.

added first skill to the docs to test this out. locally it's possible to
run: npx skills add ./docs which adds the mui-to-bui skill to be used.

Signed-off-by: Hellgren Heikki <heikki.hellgren@op.fi>
2026-03-19 14:30:06 +02:00
Fredrik Adelöw 5ea9806f17 Merge pull request #33430 from backstage/freben/sched-cancel-doc
add docs for the scheduler cancel endpoint
2026-03-19 09:45:53 +01:00
Fredrik Adelöw d7c67cddf5 switch omitIdentityTokenOwnershipClaim to true
Signed-off-by: Fredrik Adelöw <freben@spotify.com>
2026-03-18 22:10:50 +01:00