Commit Graph

234 Commits

Author SHA1 Message Date
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
Paul Schultz 2e26579e06 chore: update react imports
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2025-04-08 07:35:24 -05:00
Patrik Oldsberg e655f626ad update existing references to yarn dev to use yarn start instead
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-04-08 13:14:46 +02:00
deepthi-28 f68c528dca Changes are added for display heading in the document
Signed-off-by: deepthi-28 <deepthi.ajith@infosys.com>
2025-04-01 19:01:22 +05:30
teemoo7 5660c94c6c Fix code example in proxy tutorial doc for better consistency
Signed-off-by: teemoo7 <micael.paquier@gmail.com>
2025-03-17 17:06:06 +01:00
Patrik Oldsberg 712f96a86f Merge pull request #27934 from minkimcello/mk/cli-templates
Declarative CLI Templates
2025-02-11 14:47:55 +01:00
Fredrik Adelöw 8ccae19e82 Merge pull request #28692 from angeliski/add-rollback-tutorial
docs: add new tutorial to knex rollback
2025-02-11 11:33:50 +01:00
Fredrik Adelöw c93a9243a2 fix some accidental extra newlines in docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2025-02-10 13:34:58 +01:00
Rogerio Angeliski 0ecf0c44de docs: move use case section to the top
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-02-06 21:01:49 -03:00
Rogerio Angeliski bc758b0fc8 Apply suggestions from code review
Co-authored-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-02-06 21:00:12 -03:00
Rogerio Angeliski 0aa129f855 docs: update tutorial to split commands
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-02-04 08:36:27 -03:00
Rogerio Angeliski 17aa9532d2 Update docs/tutorials/manual-knex-rollback.md
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-02-04 08:31:30 -03:00
Rogerio Angeliski 0a54145345 docs: fix tutorial link
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-02-04 08:31:30 -03:00
Rogerio Angeliski f4a3879060 docs: update with review comments
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-02-04 08:31:29 -03:00
Rogerio Angeliski 10691ea92a docs: add new tutorial to knex rollback
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-02-04 08:31:26 -03:00
Min Kim 6eecf9e9fc Update all references of the new command in docs
Signed-off-by: Min Kim <minkimcello@gmail.com>
2025-01-23 22:35:21 -05:00
Andre Wanlin bcd42b9f79 Added note regarding new design system RFC
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-11-26 15:46:23 -06:00
Nikolai Thingnes Leira 14c18b56c3 fix: backticks formatting
Signed-off-by: Nikolai Thingnes Leira <140617589+NikolaiTL@users.noreply.github.com>
2024-11-08 17:04:18 +01:00
Nikolai Thingnes Leira 913a4593e3 chore: add newlines before and after codeblock
Signed-off-by: Nikolai Thingnes Leira <140617589+NikolaiTL@users.noreply.github.com>
2024-11-08 17:03:09 +01:00
Nikolai Thingnes Leira 05eb98f069 docs: add info about dockerignore
Signed-off-by: Nikolai Thingnes Leira <140617589+NikolaiTL@users.noreply.github.com>
2024-11-08 16:23:45 +01:00
Alex McKay 0e09050fe0 add endpoints section example app-config
Signed-off-by: Alex McKay <77302540+alex-mckay@users.noreply.github.com>
2024-10-08 14:59:12 -04:00