40 Commits

Author SHA1 Message Date
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
Patrik Oldsberg eda80c74ea cli: remove support for .icon.svg imports
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-08-11 09:52:11 +02:00
Peter Macdonald 34c75782b1 address feedback on missing styles
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2025-03-24 15:06:40 +01:00
Peter Macdonald d103dcb8d2 reopened new PR, to not have to deal with git wizardry
Signed-off-by: Peter Macdonald <peterm4c@pm.me>
2025-03-21 14:52:59 +01:00
Peter Macdonald c7856c4633 pre-requisites too over the top, pepper the recommended key concepts where they are likely used
Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2024-11-15 17:20:09 +01:00
Andre Wanlin 1145181834 Moved from root note to title
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-07-13 10:45:17 -05:00
Aramis 21684fe210 apply suggestions from code review
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2024-02-17 16:19:02 -05:00
Aramis 39599f582a fix doc links
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2024-02-17 16:19:02 -05:00
Fredrik Adelöw 9aac2b0d36 move cwd as the first argument to yarn
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-02-04 20:13:00 +01:00
Philipp Hugenroth 375b6f7d68 CircelCI repository moved
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2023-11-08 16:39:11 +01:00
Aramis Sennyey e910efaa89 additional updates in docs
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
2023-09-20 16:47:21 -04:00
Olivier Tassinari a51fb51617 fix: use Material UI vs. MUI where relevant
Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>
2023-07-04 23:49:19 +02:00
Paul Schultz 040b54f7e5 clean up formatting
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-08 10:13:38 -06:00
Paul Schultz 9c95f91c0a Add titles to codeblocks and switch from diff codeblock to language codeblock
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-01 13:30:38 -06:00
Jan Van Bruggen c51efce2a0 Update docs to always use yarn add --cwd for app & backend
Some commands currently error, and others are simply formatted inconsistently.
This format seems to work and be the most popular/common,
so I applied it to all similar occurrences.

Signed-off-by: Jan Van Bruggen <JanVB@verily.com>
2023-02-13 09:40:20 -07:00
Adam Harvey 9050e4389e chore(docs): Improve plugin example
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2023-01-23 22:47:48 -05:00
Philipp Hugenroth 7c28c82537 Improve typing by making isMobile optional & removing PropsWithChildren
Improve consistency in documentation

Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2022-01-05 16:02:39 +01:00
Philipp Hugenroth 4b8cefcf05 Update changeset & documentation
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-11-15 11:55:17 +01:00
Philipp Hugenroth 65e1a35c0f Update documentation & add changeset
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-11-10 14:45:27 +01:00
Patrik Oldsberg c614ede9a5 docs: update plugin installation docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-22 18:32:54 +02:00
Adam Harvey 2373468553 Merge pull request #5332 from adamdmharvey/update-plugin-doco
docs: Update plugin example for composability
2021-04-15 14:47:21 -04:00
Adam Harvey 2c1fc4969c Clarify example
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-04-15 14:41:10 -04:00
Adam Harvey 1c1dc8ac28 Fix pluginname
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-04-15 12:42:03 -04:00
Fredrik Adelöw c28689c686 change all $env to ${}
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-15 13:26:44 +02:00
Adam Harvey 387c28b9d3 Update plugin example for composability
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-04-14 14:42:50 -04:00
Travis Truman 8210a2ea52 Correcting the path to the Root component
Signed-off-by: Travis Truman <trumant@gmail.com>
2021-04-10 15:48:08 -04:00
Tim Hansen f88fe9dd9b Update create-app template for better parity with example app
Fixes #4613

Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-03-19 15:18:26 -06:00
Tim Hansen b17819246c Add note about monorepo
Signed-off-by: Tim Hansen <timbonicush@spotify.com>
2021-03-04 11:58:20 -07:00
Tim Hansen ffdae9be17 Update documentation, remove CircleCI from default app
Signed-off-by: Tim Hansen <timbonicush@spotify.com>
2021-03-03 15:38:50 -07:00
Frieder Bluemle cbd3a44c09 Fix typos (#3646) 2020-12-09 07:50:41 +01:00
Stefan Ålund 0ebfc75b41 Fix docs 2020-11-26 20:50:32 +01:00
Stefan Ålund 63998e65b1 Update docs/getting-started/configure-app-with-plugins.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 20:27:10 +01:00
Stefan Ålund 276a9e5919 Update docs/getting-started/configure-app-with-plugins.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 20:27:02 +01:00
Stefan Ålund 05b54d8b17 Update docs/getting-started/configure-app-with-plugins.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 20:26:53 +01:00
Stefan Ålund a00c393b38 Add API docs plugin to new apps 2020-11-26 14:20:47 +01:00
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Patrik Oldsberg d34024d1cb docs: add instructions for adding sidebar entries to getting started 2020-09-09 14:46:30 +02:00
Ivan Shmidt 882728ae1d feat: the whole docs structure
Co-authored-by: Raghunandan Balachandran <meetraghu28@gmail.com>
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 15:20:20 +02:00
Ivan Shmidt 0867d3dc30 feat: more docs to backstage.io 2020-08-12 12:06:14 +02:00
Stefan Ålund 8ec6ed5170 Documentation skeleton (#1617)
* Documentation skeleton

* Added ADR list and more

* rm material theme

* Update mkdocs.yml

* Add docs TOC

* Work for plain MD and mkdocs

* Update mkdocs.yml

* Restructuring

* Added roadmap

* Add reference APIs

* move publishing
2020-07-15 08:57:25 +02:00