Commit Graph

47 Commits

Author SHA1 Message Date
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
Alex Crome 8436e20dad Clarify docs
Signed-off-by: Alex Crome <afscrome@users.noreply.github.com>
2023-05-01 17:14:02 +01:00
Alex Crome 575d9178ef Updated customise theme docs
The custom theme document talks about System Icons, then immediatly ignores the existance of these  in the `Sidebar Sub-menu` example a couple of paragraphs later.
This commit updates the docs to make use of these icons, as well as adding an icon for resource types to the default icons.

Also updated the sidebar in example app to use this same approach

Signed-off-by: Alex Crome <afscrome@users.noreply.github.com>
2023-05-01 11:01:23 +01: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
Andre Wanlin 6db37424c5 Changes to make Vale happy, I hope
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-11-18 12:43:34 -06:00
Andre Wanlin 9d2c6a7db4 Removed from create-app and added to docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-11-18 12:25:50 -06:00
Fredrik Adelöw cbe11d1e23 just getting rid of vale warnings
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-10-22 17:18:47 +02:00
Tyler Davis 5abfbc3051 Small typo fix in Theme docs
Signed-off-by: Tyler Davis <tylerd@canva.com>
2022-09-07 11:29:16 +10:00
Andre Wanlin 0094d8ae94 Refactor icon section based on recent changes
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-08-17 14:08:09 -05:00
Andre Wanlin f8287e5340 Added UserSettingsAvailableIconsTable and related documentation
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-08-17 13:59:20 -05:00
Paulo Peixoto cfb4a12c68 fix: change HeaderIcon for ExampleIcon.
Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-10 11:47:33 -03:00
Paulo Peixoto 168bb7acdc Update app-custhome-theme.md
After suggestions @jhaals

Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-10 08:05:44 -03:00
Paulo Peixoto cdea98f2a1 Adjustments based on @awanlin suggestion.
Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-05 08:59:47 -03:00
Paulo Peixoto 8da380b0ae Update app-cusom-theme.md
Added documentation for using custom icons.

Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-04 11:10:00 -03:00
blam c333ffd2c3 chore: prettify! 🪄
Signed-off-by: blam <ben@blam.sh>
2022-07-28 11:13:42 +02:00
Damola Obaleke 8d43d374fb Update app-custom-theme.md
Updating syntax in doc for clean up of Theme object

Signed-off-by: Damola Obaleke <45045727+damolaobaleke@users.noreply.github.com>
2022-07-27 11:06:26 -07:00
Tim Hansen 6cc32f8c8d Add pointer to custom theme on demo site
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2022-04-04 17:11:20 -06:00
Andre Wanlin 5b797098b5 Added example of icon for theme
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2022-03-05 09:33:45 -06:00
Himanshu Mishra 1208397ea6 Home page -> homepage for consistency
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-16 12:33:35 +01:00
Himanshu Mishra f87a740a6a keep the custom homepage section in app custom theme page
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-09 11:02:02 +01:00
Himanshu Mishra 821bebdff7 complete instructions on setting up custom homepage
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-09 11:02:02 +01:00
Emma Indal 285d641eb6 Custom Homepage documentation (#8862)
* Fix note formatting

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* Update app-custom-theme.md

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-01-12 11:30:33 +01:00
Emma Indal bdf1419d20 [Home] first homepage template to storybook + two more home components (#8434)
* add new toolkit component

Signed-off-by: Emma Indal <emmai@spotify.com>

* add toolkit content test

Signed-off-by: Emma Indal <emmai@spotify.com>

* add key to toolkit items

Signed-off-by: Emma Indal <emmai@spotify.com>

* add reusable company logo component

Signed-off-by: Emma Indal <emmai@spotify.com>

* export root ref from search plugin

Signed-off-by: Emma Indal <emmai@spotify.com>

* add homepage template to storybook

Signed-off-by: Emma Indal <emmai@spotify.com>

* export new homepage components from plugin

Signed-off-by: Emma Indal <emmai@spotify.com>

* fix imports

Signed-off-by: Emma Indal <emmai@spotify.com>

* add search plugin to dependencies

Signed-off-by: Emma Indal <emmai@spotify.com>

* add home plugin changeset

Signed-off-by: Emma Indal <emmai@spotify.com>

* add storybook changeset

Signed-off-by: Emma Indal <emmai@spotify.com>

* delete changeset for storybook

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* delete duplicated search context provider

Signed-off-by: Emma Indal <emmai@spotify.com>

* use list item text props

Signed-off-by: Emma Indal <emmai@spotify.com>

* update home plugin documentation + add customize app docs

Signed-off-by: Emma Indal <emmai@spotify.com>

* named exports

Signed-off-by: Emma Indal <emmai@spotify.com>

* add homepage components to storybook

Signed-off-by: Emma Indal <emmai@spotify.com>

* use app config as default for company logo

Signed-off-by: Emma Indal <emmai@spotify.com>

* rename homepage template

Signed-off-by: Emma Indal <emmai@spotify.com>

* use props instead of context for tools, update Content component of card extension to accept props

Signed-off-by: Emma Indal <emmai@spotify.com>

* fix api reports + docstrings + markers

Signed-off-by: Emma Indal <emmai@spotify.com>

* export ToolkitContentProps instead of Tool

Signed-off-by: Emma Indal <emmai@spotify.com>

* docs and stories fixups

Signed-off-by: Emma Indal <emmai@spotify.com>

* do not export rootRouteRef from search plugin

Signed-off-by: Emma Indal <emmai@spotify.com>

* update docs links

Signed-off-by: Emma Indal <emmai@spotify.com>

* change unpacking of props

Signed-off-by: Emma Indal <emmai@spotify.com>

* delete extra fragment

Signed-off-by: Emma Indal <emmai@spotify.com>

* fixup searchbar border styles

Signed-off-by: Emma Indal <emmai@spotify.com>
2022-01-10 11:40:07 +01:00
Patrik Oldsberg 56efafbe28 Merge branch 'master' into update-theme-docs 2021-12-30 00:34:47 +01:00
Tim Hansen 851e9bd42e Fix outdated custom theme docs
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-12-29 14:46:57 -07:00
Colton Padden 56c8ff9be7 update docs to use ThemeProvider for custom theme overrides
Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-12-29 14:14:20 -05:00
Colton Padden 8b8118bbd4 add instructions on using themeprovider to customization docs
Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-12-29 11:58:59 -05:00
Colton Padden 17de72e406 update docs reference from @backstage/core-app-api#createApp to backstage/app-defaults#createApp
Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-12-17 15:04:35 -05:00
Daniel Ortiz Lira f275ce04ea Condense documentation to focus in the overrides instead of theme creation
Signed-off-by: Daniel Ortiz Lira <dortiz@vmware.com>
2021-09-29 09:20:15 -05:00
Daniel Ortiz Lira b68220a16a Fix typo in documentation
Signed-off-by: Daniel Ortiz Lira <dortiz@vmware.com>
2021-09-29 09:20:15 -05:00
Daniel Ortiz Lira 76510b2b67 Add documentation on how to override Backstage components
Signed-off-by: Daniel Ortiz Lira <dortiz@vmware.com>
2021-09-29 09:20:15 -05:00
Víctor bcc35de246 Run pretier on app-custom-theme.md
Signed-off-by: Víctor <vsuarez@idealista.com>
2021-09-15 22:21:05 +02:00
Víctor Suárez Fernández e9850f784e Add missing commas to app-custom-theme docs
Signed-off-by: Víctor Suárez Fernández <vicsufer@gmail.com>
Signed-off-by: Víctor <vsuarez@idealista.com>
2021-09-15 17:13:15 +02:00
Brent Schneider 2fab1dd10d Update app-custom-theme.md
added missing coma in the pageTheme header color list.

Signed-off-by: Brent Schneider <Brent.schneider@adhocteam.us>
2021-09-01 15:28:18 -07:00
blam b05210593d chore: bump the version of material-ui core to 4.12.2
Signed-off-by: blam <ben@blam.sh>
2021-07-27 23:44:43 +02:00
Patrik Oldsberg 642cec7ac7 docs: remove references to @backstage/core
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-24 12:50:40 +02:00
Adam Harvey 0568748677 Add custom logo instructions
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-05-01 08:26:22 -04:00
Remi Kristelijn 36e233cb02 fix: missing code
Signed-off-by: Remi Kristelijn <remi.kristelijn@theapsgroup.com>
2021-04-09 09:11:50 +02:00
Remi Kristelijn 24aed6be94 fix: feedback
Signed-off-by: Remi Kristelijn <remi.kristelijn@theapsgroup.com>
2021-04-08 06:25:57 +02:00
Remi Kristelijn 4438b0f6e8 fix adds pagetheme colors
closes #5235

Signed-off-by: Remi Kristelijn <remi.kristelijn@theapsgroup.com>
2021-04-07 08:43:29 +02:00
Oliver Sand 72192d847b Improve documentation
`defaultPageTheme` is a required field.

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-03-25 15:56:49 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Ivan Shmidt 0867d3dc30 feat: more docs to backstage.io 2020-08-12 12:06:14 +02:00
Patrik Oldsberg a633dce818 docs: format with prettier (#1218) 2020-06-09 19:50:41 +02:00
Patrik Oldsberg af934d4173 docs: add docs for how to create and use custom themes 2020-05-15 17:58:22 +02:00