Commit Graph

251 Commits

Author SHA1 Message Date
LvffY 22bd2bead1 [#10459] 📝 Update documentation to use yarn --cwd arg
Signed-off-by: LvffY <louberger@hotmail.fr>
2022-03-29 21:59:53 +02:00
Johan Haals cb38015608 microsite: document release bump option
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-03-16 15:05:44 +01:00
Fredrik Adelöw efc73db10c switch us over to better-sqlite3
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-03-11 15:37:50 +01:00
Johan Haals 3203784e4b Merge pull request #10048 from infracost/getting-started-docs
Getting started docs
2022-03-11 09:59:50 +01:00
Tim McFadden 8a771907a0 Add more context as to why the workflow scope is required.
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Signed-off-by: tim775 <52185+tim775@users.noreply.github.com>
2022-03-10 07:02:15 -05:00
Charlie Rudenstål f377188b09 docs: use localhost instead of 127.0.0.1
Signed-off-by: Charlie Rudenstal <charlie4@gmail.com>
2022-03-07 14:26:00 -05:00
tim775 978e4295f4 Add "workflow" as suggested scope for github token
Without this scope, following the tutorial to create a React SSR Template fails with "refusing to allow a Personal Access Token to create or update workflow `.github/workflows/build.yml` without `workflow` scope"

Signed-off-by: tim775 <52185+tim775@users.noreply.github.com>
2022-03-07 13:49:31 -05:00
Tim McFadden 96d8403a3e Update name to match screenshot and tutorial db.
Signed-off-by: tim775 <52185+tim775@users.noreply.github.com>
2022-03-07 13:37:41 -05: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
Eric Peterson 91bf1e6c1a Use @backstage/plugin-techdocs-node instead of @backstage/techdocs-common
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-03-04 09:54:19 +01:00
Saksham Sharma 3791961a4a Add the requested changes
Signed-off-by: Saksham Sharma <sakshamsharma630@gmail.com>
2022-02-22 15:45:36 +05:30
Saksham Sharma e7d2599d35 Update the docs
Signed-off-by: Saksham Sharma <sakshamsharma630@gmail.com>
2022-02-22 15:33:03 +05:30
Patrik Oldsberg 92b9197a0f Merge pull request #9492 from pwamej/patch-1
remove node version from installation instructions
2022-02-17 01:05:19 +01:00
Paweł Wamej c7a3ae7692 fix missing bullet point
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-16 19:46:01 +01:00
Emma Indal eca5c79447 fix broken storybook link
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-02-16 13:28:37 +01: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
Paweł Wamej c553646511 keep format consistent
Co-authored-by: Andrew Basson <andrew.basson@gmail.com>
Signed-off-by: Pawel Wamej <pwamej@gmail.com>
2022-02-15 07:09:39 +01:00
Pawel Wamej e33e45625e fix other references to Node LTS
Signed-off-by: Pawel Wamej <pwamej@gmail.com>
2022-02-13 00:04:58 +01:00
Pawel Wamej 90f3729b9d remove node version from installation instructions
It's outdated (v16 is the active LTS curently) and IMO it's better to link to the Node docs rather than update it every 6 months.

Signed-off-by: Pawel Wamej <pwamej@gmail.com>
2022-02-12 19:06:19 +01:00
Himanshu Mishra 029a5650fd use homepage consistently
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-11 12:32:14 +01:00
Himanshu Mishra cc274eb7ba add pre-reqs and expectations of the tutorial
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-09 11:49:28 +01:00
Himanshu Mishra d3fcf47a96 docs: use Backstage application directory
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-09 11:02:54 +01:00
Himanshu Mishra 805f8acfd0 packages/app directory
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-09 11:02:03 +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 e0ca377789 add section about the homepage template
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
MT Lewis dffe939b80 docs: add link to upgrade helper in keeping backstage updated page
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-02-03 13:21:32 +00:00
snehaljos 53de6f91c2 Updated the docs
Signed-off-by: snehaljos <joyalsnehal3421@gmail.com>
2022-01-21 13:38:57 +01:00
Fredrik Adelöw 7e8cc7d24e Merge pull request #6905 from tudi2d/mobile-sidebar
Mobile sidebar
2022-01-14 16:55:14 +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
Philipp Hugenroth 0322c6fbb9 Merge branch 'master' into mobile-sidebar 2022-01-05 16:43:17 +01: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
Fredrik Adelöw 620aae994d Merge pull request #8647 from zgriesinger/add-prefix-glob-to-version-bump
CLI: Add --prefix option to version:bump command
2022-01-04 10:33:53 +01:00
Philipp Hugenroth 78abba5ed2 Merge branch 'master' into mobile-sidebar
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2022-01-03 10:31:12 +01:00
Zackery Griesinger b471662e8a Review comments - swap prefix to pattern
Signed-off-by: Zackery Griesinger <zack.griesinger@c2fo.com>
2021-12-30 10:21:45 -06:00
Zack Griesinger 93d8a6f0bb Update docs
Signed-off-by: Zack Griesinger <zack.griesinger@c2fo.com>
2021-12-30 10:21:44 -06: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
Philipp Hugenroth 858b6e40c9 Merge branch 'master' into mobile-sidebar
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-12-28 18:39:03 +01:00
Suzanne Daniels 3bc9681263 Fixing image for PAT creation
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-22 10:07:32 +01:00
Suzanne Daniels 25f668d583 Link fixing
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-21 21:03:11 +01:00
Suzanne Daniels 20b96aa6db Prettier ^^
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-21 20:27:25 +01:00
Suzanne Daniels f2bbca8dcf Linking to part two, fixing spelling & script colorizing
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-21 09:59:31 +01:00
Suzanne Daniels 160d6b71e9 Merge branch 'backstage:master' into suuus/docs-2 2021-12-21 09:47:47 +01: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
Suzanne Daniels 32d733fbf1 removing modifications
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-07 17:17:35 +01:00
Philipp Hugenroth 5f1db7a43a Merge branch 'master' into mobile-sidebar
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-12-07 11:10:41 +01:00