14 Commits

Author SHA1 Message Date
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
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
Aramis Sennyey 722b35e1a4 docs: use accordions for common issues in golden-path (#33840)
* fix: use accordions for common issues

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

* fix code block

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

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2026-04-13 10:23:44 -04:00
Aramis Sennyey 2b4f97adf7 docs: frontend plugin golden path (#33541)
* docs: frontend plugin golden path guide

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

* add changeset

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

* Apply suggestion from @aramissennyeydd

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

* fix template

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

* fix template test

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

* print stderr on failure

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

* try writing directly

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

* maybe this?

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

* address feedback

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

* fix: avoid destructuring FetchApi and fix template issues

- Use fetchApi.fetch() instead of destructuring to preserve this binding
- Add discoveryApi and fetchApi to useAsync dependency array
- Use react-use/esm/useAsync to match repo conventions
- Replace waitFor + getAllByText with findByText in error test
- Update HTTP client doc to match template changes

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

* fix: address docs review feedback

- Use stronger guidance tone in scaffolding guide intro
- Slim down file tree to show folder structure only
- Mention that plugin path depends on chosen plugin ID
- Link to installation docs for non-discovery case
- Quote page:todo YAML key to avoid parse errors
- Remove "new" from "new frontend system" in template README

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

* fix: improve error handling in e2e plugin creation

- Narrow error to non-null object before using in operator
- Also write error.stdout since tools like Jest report to stdout
- Avoid variable shadowing with outer scope stdout/stderr

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

* revert: keep destructured fetch from FetchApi

Destructuring fetch from FetchApi is fine — revert to original
pattern while keeping the dependency array and other fixes.

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

* feat: use @backstage/ui components in frontend plugin template

Replace core-components layout and table with @backstage/ui equivalents:
- Use HeaderPage and Container instead of Page, Header, Content, ContentHeader
- Use BUI Table with useTable and CellText instead of core-components Table
- Add @backstage/ui to template package.json dependencies
- Update poking-around docs to reflect BUI component usage

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

* fix: add example data when backend request fails

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

* better logging setup

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

* address feedback

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

* better config driven example

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

* debug logs

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

* fix build failure related to unknown version

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

* revert e2e run changes

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>

* skip the discovery api for now

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

* remove another ref

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>

---------

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-04-10 14:00:55 -04: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
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
Peter Macdonald f34dc2a6f3 update golden paths permissions section
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2026-03-24 14:48:51 +01: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
Aramis Sennyey 8f6bf6b4e7 docs: adding more golden path docs (#32493)
* docs: adding more golden path docs

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

* cleanup

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

* add instructions for checking todo list items

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

* update ids so the number isn't baked into URL

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

* add headings for all docs

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

* add frontend plugin docs structure too

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>

* 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 bad link

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

* address feedback

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>

---------

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>
2026-02-13 14:20:32 -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
aramissennyeydd 0acbd34276 updates following sig
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2025-02-28 10:11:21 -06:00
aramissennyeydd ed80ef94b3 feat(docs): start preparing a golden path
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2025-02-14 14:24:13 -05:00