Commit Graph

254 Commits

Author SHA1 Message Date
Timo Sand d2c181f539 Update TOC
Signed-off-by: Timo Sand <timo.sand@f-secure.com>
2026-05-27 01:02:06 +03:00
Timo Sand f56177b47e Replace mentions of react-use in docs with @react-hookz/web
Signed-off-by: Timo Sand <timo.sand@f-secure.com>
2026-05-27 01:01:20 +03: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
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
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
Andre Wanlin 8bf97618ee Fixed links
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-04-03 12:39:28 -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
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
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 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
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
Patrik Oldsberg 208442d755 docs: fix broken API reference links
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-18 13:31:46 +01:00
Patrik Oldsberg 73deff4947 Merge pull request #33316 from chanchalkhatri19/add-golden-path-descriptions
docs: add missing description frontmatter to golden-path docs
2026-03-17 22:03:49 +01:00
Jon Koops 956133bf45 docs: recommend Node.js built-in proxy support for corporate proxies (#33006)
Node.js 22.21.0+ natively supports HTTP_PROXY, HTTPS_PROXY, and
NO_PROXY environment variables via NODE_USE_ENV_PROXY, eliminating the
need for undici and global-agent workarounds. This also works with
node-fetch and cross-fetch since they delegate to node:http/node:https
without overriding the HTTP agent.

Add a new corporate proxy tutorial under docs/ with the recommended
approach and update the legacy guide in contrib/ to point to it.
Update proxy references in the deployment, keeping-backstage-updated,
and TechDocs CLI docs to mention NODE_USE_ENV_PROXY.

Signed-off-by: Jon Koops <jonkoops@gmail.com>
2026-03-17 13:13:00 -04:00
chanchalkhatri19 21608833fa docs: add missing description frontmatter to golden-path docs
Signed-off-by: chanchalkhatri19 <chanchal.khatri01@infosys.com>
2026-03-12 12:44:43 +00:00
Patrik Oldsberg 33de79d5dd Remove deprecated createPublicSignInApp from @backstage/frontend-defaults
The function was deprecated in favor of using `createApp` with the
`appModulePublicSignIn` module from `@backstage/plugin-app/alpha`.
This removes the function, its tests, and updates the documentation
to use the recommended approach.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-03-05 10:33:45 +01:00
Patrik Oldsberg cec462fe73 Merge pull request #32592 from chanchalkhatri19/docs/fix-todo-placeholder-link
docs: fix TODO placeholder link in quickstart-app-plugin tutorial
2026-02-03 20:47:36 +01:00
chanchalkhatri19 72cef7e15a docs: fix TODO placeholder link in quickstart-app-plugin tutorial
Signed-off-by: chanchalkhatri19 <chanchal.khatri01@infosys.com>
2026-01-30 08:21:29 +00:00
Deepthi Ajith 3519cba943 docs: add anchor links to quickstart-app-plugin tutorial sections
Signed-off-by: Deepthi Ajith <deepthi.ajith@infosys.com>
2026-01-28 08:30:58 +00:00
Aramis Sennyey bd655dcc6b Merge pull request #32189 from backstage/sennyeya/fix-reference-links 2025-12-20 10:03:03 -05:00
Peter Macdonald 7804f74070 tweaking
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2025-12-19 11:30:59 +01:00
Peter Macdonald 13c093afb3 add copy paste commands
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2025-12-19 11:03:23 +01:00
aramissennyeydd 3904a1ac1c chore: point to new api reference site
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2025-12-18 10:27:56 -07:00
Peter Macdonald dc678e4469 slight rewording
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2025-12-18 16:51:32 +01:00
Peter Macdonald aef8b0d0f2 add jest types for jest migration
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2025-12-18 16:47:36 +01:00
Johan Persson 87e4e8b4b8 fix(docs): Emphasis Jest 30 upgrade is recommended
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Signed-off-by: Johan Persson <johanopersson@gmail.com>
2025-12-12 14:49:31 +01:00
Johan Persson cd0b8a11a3 chore: make jest a peer dependency with v29/v30 support
Move jest from dependencies to peer dependencies, allowing users to
choose between Jest 29 and Jest 30.

The CLI now detects the Jest version at runtime and uses the
appropriate environment:
- Jest 29: Uses standard jest-environment-jsdom
- Jest 30: Uses a custom environment based on @jest/environment-jsdom-abstract
  with fixes for Web API globals (fetch, streams, Error, etc.)

The cross-fetch polyfill is only injected for Jest 29, as with Jest 30+
our patched Jest environment is used. The network request blocker is made
MSW-compatible by checking if fetch was wrapped before blocking.

Jest 30 (with jsdom v27) fixes `Could not parse CSS stylesheet`
warnings/errors when testing components from @backstage/ui or other
packages using CSS `@layer` declarations.

New peer dependencies (install based on your Jest version):
- jest (required, ^29 or ^30)
- Jest 29 requires: jest-environment-jsdom
- Jest 30 requires: @jest/environment-jsdom-abstract, jsdom

Production code changes for jsdom 27 testability:
- AppIdentityProxy: extract navigateToUrl method for spying
- LiveReloadAddon: export utils.reloadPage for spying
- collect.ts: export internal.resolvePackagePath for mocking

MockFetchApi: evaluate global.fetch at call time instead of construction
time, allowing MSW to patch fetch after MockFetchApi is constructed.

Test adaptations for jsdom 27:
- Use RGB values instead of named colors in CSS assertions
- Update error format expectations (hyphenated type names, SyntaxError
  instead of FetchError for JSON parse errors)
- Simplify URL error assertions for cross-version compatibility
- Fix accessible name whitespace handling for external links
- Use history.replaceState for location mocking (non-configurable)
- Use fireEvent.blur for contentEditable elements
- Move async assertions inside waitFor for race conditions
- Remove Blob.prototype.text polyfill (now native)
- Remove test case using credentials in plugin:// URLs

Test adaptations for Jest 30:
- Replace `expect.objectContaining([...])` with direct array equality
- Replace `expect.objectContaining({ length: N })` with
  `expect.any(Array)` + separate `toHaveLength()` assertions
- Use child process for native Node.js module resolution in
  collect.test.ts to work around Jest 30's resolver behavior
- Update snapshot headers for new Jest format

Also removes the jest-haste-map patch which is no longer needed.

Signed-off-by: Johan Persson <johanopersson@gmail.com>
2025-12-11 18:06:55 +01:00
Patrik Oldsberg 64e521767d docs: update links to point to frontend-plugin-api
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-11-23 12:56:08 +01:00
Fredrik Adelöw 5e98e613b5 Fix a bunch of vale errors
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2025-10-13 20:40:59 +02:00
Abhishek B faf0f07e02 Correct the database name associated with the catalog plugin
Signed-off-by: Abhishek B <abhishek.b@zeptonow.com>
2025-09-24 18:09:35 +05:30
Fredrik Adelöw e60b871986 Merge pull request #30394 from 04kash/tutorial/adding-events
Add Docs on Integrating Event-Driven Updates with Entity Providers
2025-08-25 09:37:43 +02:00
Kashish Mittal 71a085dcea address review comments
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
2025-08-19 10:07:09 -04:00
Andre Wanlin 195e6aca8e Adjustments based on feedback
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-07-17 12:16:53 -05:00
Andre Wanlin 201a63b6f6 Docs - Added Traces to Otel tutorial
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-07-17 12:12:43 -05:00
Kashish Mittal b2c0d3d374 add docs on integrating event driven updates with backstage entity providers
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
2025-07-13 04:37:18 -04:00
Andre Wanlin b5545900a4 Initial removal
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-06-06 13:14:54 -05:00
Andre Wanlin 7028ce6cde Added details regarding OpenTelemetry Views
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-05-27 09:24:13 -05:00
Vincenzo Scamporlino dbfab1fa9e docs: tweaks proxy usage
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2025-05-09 21:37:27 +02:00
Eddie Hale b880c09e71 updated OTEL example referenced in #29282
Signed-off-by: Eddie Hale <eddie.hale@gmail.com>
2025-04-30 17:13:52 -05:00
Fredrik Adelöw 4f63426a59 update documentation to register metrics once
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2025-04-25 13:00:45 +02:00
Fredrik Adelöw 9d488458fe Merge pull request #29438 from deepthi-28/technical_backstageproxy
Changes are added for display heading in the document
2025-04-22 13:26:11 +02:00
Paul Schultz e775870cc2 apply requested changes
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-15 07:38:45 -05:00
Paul Schultz fa24be548e Update docs/tutorials/jsx-transform-migration.md
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-15 07:34:30 -05:00
Paul Schultz edebe418a9 separate codemod into a different file
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-15 07:34:29 -05:00
Paul Schultz ccf4379e1c add config file changes
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-15 07:34:28 -05:00
Paul Schultz d92abd3b32 apply requested changes
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-15 07:34:28 -05:00
Paul Schultz b45d558d09 update react 18 guide
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-15 07:34:27 -05:00
Paul Schultz dfea8cc850 docs: add new JSX Transform guide
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-15 07:34:27 -05:00
Patrik Oldsberg 32cbef5b4c Merge pull request #29499 from schultzp2020/react-imports
chore: update react imports
2025-04-08 18:52:18 +02:00