Commit Graph

224 Commits

Author SHA1 Message Date
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
Andre Wanlin 6e6eff9b90 Fixes
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-04-03 12:28:56 -05: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
Andre Wanlin 00617627b1 Merge pull request #33069 from awanlin/docs/scaffolder-clean-up
[Doc] Scaffolder clean up
2026-03-17 13:37:57 -05:00
Patrik Oldsberg d9655bcb16 Remove empty publish-private doc page
The page only contained a TODO placeholder and was never filled in.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-17 14:55:18 +01:00
Patrik Oldsberg aac778ba8c docs: adapt cross-cutting plugin docs into the frontend system section
Instead of just referencing the legacy docs/plugins documentation, adapt
and add them as new pages under frontend-system/building-plugins/ with
updated imports and examples for the new frontend system.

Also moves the OpenAPI sidebar entry under Framework instead of top-level.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-17 11:05:09 +01:00
Patrik Oldsberg 35e130c601 docs: sunset the docs/plugins section as legacy documentation
Mark all pages in docs/plugins/ with legacy admonition banners pointing
to the appropriate new frontend system and backend system documentation.
Rename the sidebar section to "Plugins (Legacy)" and move it lower in
the navigation hierarchy. Add cross-references from the new frontend
system building-plugins guide to relevant cross-cutting topics (i18n,
analytics, feature flags, search) that still live in the legacy section.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-17 10:49:54 +01:00
Andre Wanlin 88fef53c08 Removed redirect based on feedback
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-03-14 09:27:49 -05:00
Andre Wanlin 765725c8c2 Fixed CI and addressed feedback
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-03-14 09:23:25 -05:00
Andre Wanlin b35de8d2aa [Docs] Scaffolder Clean Up
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-03-14 09:23:25 -05:00
Andre Wanlin 32cb991728 Merge pull request #31842 from milliehartnt123/milliehartnt123-create-ui-doc
Updated Using Backstage documentation for Feature Issue 21943 Write a UI Guide
2026-02-27 11:15:35 -06:00
Patrik Oldsberg fd50cb3401 docs: add changeset and documentation for translations CLI commands
Adds a changeset for the new translations export/import CLI commands.
Updates the internationalization docs with the CLI-based workflow as
the recommended approach for managing translations, and adds the
commands to the CLI reference. Also adds the internationalization
page to the mkdocs navigation.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-18 00:47:14 +01:00
milliehartnt123 96f394a3e0 Rename 'Searching the Catalog' to 'Filtering the Catalog'
Also updated the name of the md file from search-catalog to filter-catalog.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2026-02-12 09:11:01 -05:00
milliehartnt123 0e7d0b7347 Add Technical overview to sidebar navigation
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2026-01-13 13:37:17 -05:00
milliehartnt123 3617c032e2 Merge branch 'backstage:master' into milliehartnt123-create-ui-doc 2026-01-05 12:42:21 -05:00
Peter Macdonald 032f2a8468 Some small tidying up of the docs site
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-01-05 09:38:56 +01:00
milliehartnt123 04ae2de1d2 Fix prettier errors
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-12-09 09:02:26 -07:00
milliehartnt123 e31d6436e4 Moved the location of Searching the Catalog
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-12-09 08:07:00 -07:00
milliehartnt123 851d4ec3da Add unregister/delete component documentation link
Add link for unregister/delete a component to the Using Backstage > Managing Components section.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-12-04 10:25:31 -07:00
milliehartnt123 cc60909224 Add new structure and documents to Using Backstage section
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-11-24 10:46:53 -05:00
milliehartnt123 24ce8d8e55 Refactor component management section in mkdocs.yml
Undo changes made to file in the Using Backstage section under Getting Started. Reverted back to master branch version. Made my changes in the sidebars.ts file instead.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-11-13 14:50:12 -05:00
milliehartnt123 5428a1a2f5 Reorganize Backstage getting started documentation
Adding new subheading, "Managing Components" and put Registering a Component and Creating a Component under it. Also added a new Updating a Component page to the section.

Added a new UI Overview page before the Managing Components subheading.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-11-11 11:00:49 -05:00
Charles de Dreuille 1dfaeeebdf Update mkdocs.yml
Signed-off-by: Charles de Dreuille <charles.dedreuille@gmail.com>
2025-09-12 11:58:41 +01:00
Vinnie McGuinness 6115bb4a0c chore: add integrations gitea discovery to docs sidebar
Signed-off-by: Vinnie McGuinness <vinnie.mcguinness@intive.com>
2025-06-10 16:41:12 +01:00
Matt Benson f20bebc941 rename template extensions->templating extensions in docs
Signed-off-by: Matt Benson <gudnabrsam@gmail.com>
2025-05-07 09:58:32 -05:00
Ben Lambert a72d2e18ae Merge pull request #28779 from mbenson/scaffolder-template-extensions-stage1
Scaffolder template extensions stage1
2025-02-11 15:20:44 +01:00
Matt Benson dc8dd4bea7 add enhanced/documented filter/global types and creator functions
Signed-off-by: Matt Benson <gudnabrsam@gmail.com>
2025-02-09 13:07:26 -06: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
Heikki Hellgren bed5f35e35 docs(notifications): split to multiple docs and add more info
- split docs to 3 different pages; getting started, processors and usage
- add information about email notifications
- add information about scaffolder module

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
2024-12-16 09:20:58 +02:00
Fredrik Adelöw 3ecfb12185 move to a new ADR
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-11-29 13:52:35 +01:00
Fredrik Adelöw e4ccf4a600 recommend undici
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-11-29 12:03:08 +01:00
Peter Macdonald b5baaf5723 moving docs around, updating deployment overview section to point to contrib folder for community deployment methods
Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2024-11-18 09:13:42 +01:00
Peter Macdonald ca796b2fc9 updating mkdocs file
Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2024-11-15 14:10:20 +01:00
Jonathan Roebuck 16a436abfc use redirect instead of docs/index.md
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
2024-11-06 09:04:34 +00:00
Joshua Jung 8976bc0e94 Adding some documentation on how to use the TechDocs extensions
Signed-off-by: Joshua Jung <joshua.p.jung@gmail.com>
2024-09-13 14:44:13 -05:00
blam 5509b5a829 chore: smol fix
Signed-off-by: blam <ben@blam.sh>
2024-09-11 12:13:33 +02:00
Fredrik Adelöw 060e02d706 started on a catalog faq page
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-09-09 14:53:02 +02:00
Heikki Hellgren ed81ab07e2 docs(debug): add information about profiling
Add information to documentation how to profile and stress test
Backstage application.

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
2024-08-30 12:42:05 +03:00
Johan Haals 079abacea3 remove urlReader from mkdocs
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2024-08-28 09:37:15 +02:00
Ben Lambert 1c5ec2bd6b Merge pull request #25621 from awanlin/doc/search-nbs
[NBS] Updated Search Docs
2024-08-14 09:27:42 +02:00
Ben Lambert 31842c15a6 Merge pull request #25507 from fidelity-contributions/issue-25352-dryrun-testing-section
Issue 25352 dryrun testing section
2024-08-05 08:30:42 +02:00
Nolan, Tavi 9d6ad1eeb6 Update mkdocs.yml file path
Signed-off-by: Nolan, Tavi <Tavi.Nolan@fmr.com>
2024-07-30 14:26:33 +01:00
Andre Wanlin 120e195aca Updated mkdocs
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-07-28 18:26:07 -05:00
Nolan, Tavi e5e7d0501b Update mkdocs.yml
Signed-off-by: Nolan, Tavi <Tavi.Nolan@fmr.com>
2024-07-23 12:43:43 +01:00
Tavi Nolan 612d552e1c Updating changes based on review comments
Signed-off-by: Tavi Nolan <Tavi.Nolan@fmr.com>
2024-07-23 11:45:56 +01:00
Andre Wanlin 668fe02828 [NBS] Updated Search Docs
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-07-15 07:38:58 -05:00
Andre Wanlin b4e401fd9e Fixed links and MkDocs config
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-07-05 13:32:46 -05:00
Tavi Nolan 54a0cc779b Creating dry run documentation
Signed-off-by: Tavi Nolan <Tavi.Nolan@fmr.com>
2024-06-25 09:35:43 +01:00
Patrik Oldsberg 7fe9057f9c Merge pull request #25223 from backstage/rugvip/package-docs
docs: add new tooling section with a package metadata reference
2024-06-13 17:35:17 +02:00
Fredrik Adelöw 422ee46077 add some basic aws alb docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-06-13 12:05:26 +02:00