paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 30 Packages Projects Releases Wiki Activity
74,233 Commits 1 Branch 0 Tags
master
Commit Graph

66 Commits

Author SHA1 Message Date
ryoku4 80d86dbbd2 docs: correct "Github" to "GitHub" for consistency in branding 
Signed-off-by: ryoku4 <122875619+ryoku4@users.noreply.github.com>
 2026-05-22 22:55:25 +09:00
Aramis Sennyey 3b8c0557c6 golden-path: backend plugin persistence guide (#33540) 
* docs: backend plugin persistence guide

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

* fix prettier

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

* add dto section

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

* Apply suggestion from @aramissennyeydd

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

* address feedback

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

* test against real scaffolding

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 knex migrate:make command to specify migrations directory

Without --migrations-directory, knex cannot resolve the config
and errors with "Failed to resolve config file".

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

* address copilot review feedback

- Fix file paths in code snippets to match scaffolded layout (src/ prefix)
- Add missing semicolons in toDatabaseRow/fromDatabaseRow return objects
- Change knex from devDependency to regular dependency for type imports
- Add missing customize-your-instance to adoption sidebar

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
 2026-04-22 10:12:51 -04: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
Andre Wanlin e66fa1898c Sidebar fix 
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
 2026-04-03 12:30:40 -05: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
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
Peter Macdonald 5848bc40e8 add adoption to the golden paths sidebar items 
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
 2026-03-25 13:35:03 +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
Jon Koops 8f0a47f545 docs: add corporate proxy tutorial to sidebar navigation 
The corporate proxy tutorial added in #33006 is not visible in the
docs sidebar. Add it to the Technical tutorials section so that it
is discoverable at https://backstage.io/docs/tutorials/corporate-proxy.

Signed-off-by: Jon Koops <jonkoops@gmail.com>
 2026-03-19 11:20:35 +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 c5cbc84e7f Fix prettier formatting in microsite sidebars 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
 2026-03-17 15:25:33 +01: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 f8161a67fa docs: address review feedback on migrated plugin docs 
- Update internationalization page to use new frontend system patterns
  (TranslationBlueprint from @backstage/plugin-app-react instead of
  createApp __experimentalTranslations)
- Fix AnalyticsImplementationBlueprint import to use @backstage/plugin-app-react
- Remove search integration page from frontend-system section as it
  belongs in the core feature search docs

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
 2026-03-17 11:26:12 +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
Patrik Oldsberg 55b18a3c2e Merge pull request #33113 from backstage/rugvip/docs-frontend-plugin-installation 
docs: default frontend plugin docs to the new frontend system
 2026-03-16 22:08:47 +01:00
Patrik Oldsberg 90a02779fa Address remaining docs review feedback 
Clarify the remaining old frontend system sections, tighten the scaffolder follow-up wording, and rename the docs sidebar entry to match the frontend system terminology used elsewhere.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
 2026-03-16 19:45:41 +01:00
Peter Macdonald 1e2c57ebb0 Merge pull request #33334 from chanchalkhatri19/docs/okta-entity-provider 
docs: add Okta entity provider documentation
 2026-03-14 22:42:39 +01: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 52fba1c57e Review feedback 
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
 2026-03-13 17:59:21 -05:00
Andre Wanlin f3a9100932 Feedback corrections 
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
 2026-03-13 16:47:40 -05:00
Andre Wanlin 9b48446864 Added new AI section 
Co-authored-by: Nawaraj <mbk36900@gmail.com>
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
 2026-03-13 16:38:16 -05:00
chanchalkhatri19 26c09a1883 docs: add Okta entity provider documentation 
Signed-off-by: chanchalkhatri19 <chanchal.khatri01@infosys.com>
 2026-03-13 13:31:11 +00:00
Patrik Oldsberg 5a463b320c docs: update frontend plugin docs to default to new frontend system 
Restructure plugin documentation so that the new frontend system is
the default, unlabeled installation path. Old frontend system
instructions are moved to a dedicated "Old Frontend System" section.

Add a new "Installing Plugins" page to the frontend system docs
covering package discovery, manual installation, and configuration.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
 2026-03-04 11:24:35 +01: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
Kurt King cbaab58945 docs: metrics service alpha 
Signed-off-by: Kurt King <kurtaking@gmail.com>
 2026-02-25 22:45:23 -07:00
Fredrik Adelöw b1919bdf2a Merge pull request #32871 from awanlin/microsite/plugin-audit-process 
Plugin Directory Audit Process
 2026-02-19 14:56:57 +01:00
Patrik Oldsberg fef897393b docs: add missing sharing extensions sidebar item 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2026-02-18 12:08:01 +01:00
milliehartnt123 e46ec22005 Merge branch 'backstage:master' into milliehartnt123-create-ui-doc 2026-02-17 09:23:28 -05:00
Andre Wanlin 29e27ac704 Clean up and prettier 
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
 2026-02-16 19:01:13 -06:00
Andre Wanlin 9b60bef5b6 Docs 
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
 2026-02-16 18:14:50 -06:00
Patrik Oldsberg 903a854ebc Merge branch 'master' into runtime-module-federation-enablement 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2026-02-12 23:46:00 +01:00
milliehartnt123 99f170eae6 Rename 'search-catalog' to 'filter-catalog' 
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
 2026-02-12 09:07:34 -05:00
Patrik Oldsberg 0a1faaa076 docs/frontend-system: add utility API testing docs 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2026-02-07 00:06:58 +01:00
Aramis Sennyey 580de5ade2 docs: fix overlapping generated pages (#32603) 
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
 2026-01-30 11:46:18 -05:00
Andre Wanlin f57aa1785a docs - Added ui:options Examples to the Sidebar 
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
 2026-01-29 07:20:33 -06:00
David Festal 86bb4321a9 Add and update documentation 
Signed-off-by: David Festal <dfestal@redhat.com>
Assisted-by: Cursor
 2026-01-27 14:54:19 +01:00
Aramis Sennyey 1e669ccd64 chore: migrate audit events docs to docsite (#32143) 
* chore: migrate audit events docs to docsite

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

* change headers

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

* fix rebase conflict in sidebars.ts

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

* correct sidebar

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

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
 2026-01-22 08:45:06 -07:00
Patrik Oldsberg 1a3b4bccec Merge pull request #31690 from backstage/sennyeya/disable-ref-build 
chore: disable old api reference generation
 2026-01-22 15:14:13 +01:00
milliehartnt123 3617c032e2 Merge branch 'backstage:master' into milliehartnt123-create-ui-doc 2026-01-05 12:42:21 -05:00
Aramis Sennyey ae31b31664 fix: generated index URLs were URI encoded (#32226) 
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
 2026-01-05 09:17:18 -07: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 7ac601484b Update sidebar links in sidebars.ts 
Added new files and structure for Using Backstage after resolving merge conflicts that incorporated a new format for the sidebars file.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
 2025-12-23 10:25:05 -05:00
aramissennyeydd 9fd02a4e12 fix sidebar conflict 
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
 2025-12-20 20:36:07 -07:00
Aramis Sennyey 139acf332d feat: add generated index pages for all sidebar items (#32036) 
* feat: add generated index pages for all sidebar items

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

* fix merge conflict

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

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
 2025-12-18 07:16:28 -07:00
Fredrik Adelöw 6d04ff0bb2 add the jest30 migration to the sidebar 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2025-12-17 19:37:48 +01:00
Peter Macdonald 0d04221794 Adds missing ADR to docs site (adr-015) (#32129) 
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
 2025-12-15 07:44:49 -07:00
aramissennyeydd 7d201ad7cb chore(docs): add root instance metadata to sidebar 
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
 2025-12-08 17:30:56 -05:00
Aramis Sennyey 9f298e81ee docs: start creating a golden path (#30925) 
* docs: starting to fill out the plugin golden path

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

* another bit of work

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

* create-app docs

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

* Apply suggestions from code review

Co-authored-by: Peter Macdonald <peterm4c@pm.me>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

* address PR feedback

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

* update to rspack

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

* fix lint errors

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

* add flag for golden paths

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: Peter Macdonald <peterm4c@pm.me>
 2025-10-22 12:02:43 -04:00
Patrik Oldsberg a4add851a4 Merge pull request #31108 from backstage/docs-theming 
Improving theming documentation
 2025-10-07 20:57:55 +02:00