Commit Graph

815 Commits

Author SHA1 Message Date
Julio Zynger 7235b16054 Rename annotation
Signed-off-by: Julio Zynger <julio.zynger@soundcloud.com>
2022-03-07 15:05:55 +01:00
Julio Zynger 7ef026339d Add Periskop plugin
Signed-off-by: Julio Zynger <julio.zynger@soundcloud.com>
2022-03-07 15:05:32 +01:00
Eric Peterson c938e0d61d Merge pull request #9952 from backstage/iameap/mv-techdocs-search-common 2022-03-04 20:06:39 +01:00
Eric Peterson 3e54f6c436 Use @backstage/plugin-search-common instead of @backstage/search-common
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-03-04 18:47:55 +01:00
Eric Peterson 0e39d0b4fe Update documentation to reflect search beta.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-03-04 10:51:03 +01: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
Taras Mankovski dc2a5c307c Missing async from getCollator causes type mismatch
Signed-off-by: Taras Mankovski <taras@frontside.com>
2022-03-03 14:32:17 -08:00
Patrik Oldsberg 40d9d391ff Merge pull request #9873 from heyLu/fix-nesting
Fix header nesting in software-templates docs
2022-03-03 18:12:19 +01:00
Eric Peterson 022507c860 Document stream-based search
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-03-02 17:29:18 +01:00
Emma Indal bf4007da6b Merge pull request #9556 from RoadieHQ/auto-add-techdocs-core-plugin
Auto add techdocs core plugin
2022-03-02 15:42:58 +01:00
Emma Indal 7097dbac62 Merge pull request #9567 from Niksko/docs-build-strategy
Add a new interface: DocsBuildStrategy
2022-03-02 15:42:37 +01:00
Fredrik Adelöw 83a83381b0 rearrange
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-03-01 14:44:59 +01:00
Luna Stadler 33ae7f244b Fix header nesting in software-templates docs
Most pages in the 'Software Templates' docs seemed to have one level too
much nesting.  This fixes that.  Without the correct nesting, the table
of contents on the right side was also missing and made reading the
longer pages (e.g. writing-templates) more difficult to read.

What's odd is that when rendering with `mkdocs` locally the nesting
seems to be okay and the table of content renders.

Pages affected live:

- https://backstage.io/docs/features/software-templates/software-templates-index
- https://backstage.io/docs/features/software-templates/configuration
- https://backstage.io/docs/features/software-templates/writing-templates
- https://backstage.io/docs/features/software-templates/builtin-actions
- https://backstage.io/docs/features/software-templates/writing-custom-actions

https://backstage.io/docs/features/software-templates/adding-templates
is okay because it has no subheadings.

And these two are okay because they have correct nesting starting at
level two (`##`):

- https://backstage.io/docs/features/software-templates/writing-custom-field-extensions
- https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3

Signed-off-by: Luna Stadler <luc@spreadshirt.net>
2022-03-01 11:50:47 +01:00
Nikolas Skoufis 44a1a447cc Fix up links to other pages
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
2022-03-01 19:28:53 +11:00
Jussi Hallila ff0a16fb1a Add techdocs-core plugin to techdocs builder automatically
Currently users need to modify their mkdocs files to container techdocs-core plugin manually when they want to expose techdocs in Backstage. To have a standardized set of extensions without the need to modify existing files (and possibly pollute alternative/additional mkdocs pipelines) this should be added automatically.

This PR adds a helper function to modify the mkdocs file to contain this plugin if it doesn't exist in the config file.

Co-authored-by: @emmaindal

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2022-03-01 08:20:40 +01:00
Nikolas Skoufis 55031596f2 Prettify how to
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
2022-03-01 09:26:07 +11:00
Nikolas Skoufis 0bedff8c9a Add docs for build strategy stuff
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
2022-02-27 19:11:09 +11:00
Patrik Oldsberg ed09ad8093 catalog-model: move LocationSpec to catalog-backend
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-21 18:53:13 +01:00
Johan Haals b776ce5aab catalog-react: Rename useEntityListProvider hook to useEntityList
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-02-21 13:32:37 +01:00
Patrik Oldsberg 209fd128e6 removed all references to the removed SCM-specific location types
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-17 17:46:04 +01:00
Johan Haals df61ca71dd catalog-backend: Require impl of getProcessorName in CatalogProcessor
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-02-17 14:54:32 +01:00
Camila Belo 93318c97c1 Merge pull request #9364 from backstage/vinzscam/search-modal-fetch-on-open
SearchModal invoke search only when visible
2022-02-14 07:38:11 +01:00
Ben Lambert d2a24dcb29 Merge pull request #9456 from RoadieHQ/add-missing-step-to-migration-docs
add missing step to docs
2022-02-10 17:26:17 +01:00
Kiss Miklos 4610dab453 Make header more readable
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 17:08:19 +01:00
Kiss Miklos 17240b1c17 run prettier on changed file
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 16:52:58 +01:00
Kiss Miklos 4a3386a35c remove accidental change
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 16:17:41 +01:00
Kiss Miklos 1c6825d88a add missing step to docs
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 16:13:28 +01:00
Fredrik Adelöw dc66b0ab3f Merge pull request #9376 from K-Phoen/resource-dependency-of
Resource dependency of
2022-02-10 15:54:53 +01:00
Vincenzo Scamporlino 52d2d36b4b Move SearchModal state to useSearchModal
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2022-02-10 07:19:09 +01:00
Jahred Hope d9ac082bef Update link to moved repository - techdocs-cli (#9305) 2022-02-07 22:33:34 +01:00
Kévin Gomez 50d71061ca Support "dependencyOf" relation in Resource entities
Signed-off-by: Kévin Gomez <contact@kevingomez.fr>
2022-02-06 16:11:27 +01:00
Fredrik Adelöw 85e5bdfe51 more entity docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-02-03 13:36:52 +01:00
blam 37a3fc75c0 chore: more code review fixes
Signed-off-by: blam <ben@blam.sh>
2022-02-01 09:02:32 +01:00
blam b856b156c2 docs: making the docs a little clearer
Signed-off-by: blam <ben@blam.sh>
2022-02-01 09:02:32 +01:00
blam c95df1631e chore: added changeset and updating documentation about being able to grab the user token
Signed-off-by: blam <ben@blam.sh>
2022-02-01 09:02:32 +01:00
Fredrik Adelöw c710467ba2 fix callouts
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-01-31 10:09:46 +01:00
Fredrik Adelöw 9a7f28779a add catalog API docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-01-31 09:45:45 +01:00
Eric Peterson 912b2d9925 Note default ServerURL config in kroki how-to
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-01-28 10:45:59 +01:00
Patrik Oldsberg 4fb3347370 Merge pull request #9181 from backstage/rugvip/pretty
docs: remove prettier configuration with proseWrap setting
2022-01-27 10:54:36 +01:00
Patrik Oldsberg 9e3a06f09f Merge pull request #8983 from alefcarlos/feat/plugin-dotnet-backend
feat: added backend .NET scaffolder plugin
2022-01-26 18:43:33 +01:00
Patrik Oldsberg efe02b86ff docs: tweak line wrapping of doc action
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-01-26 14:35:06 +01:00
Fredrik Adelöw 0019cea06f clarify that providers should be started AFTER the catalog
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-01-26 14:08:53 +01:00
Patrik Oldsberg 4cad73ca7f run prettier
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-01-26 12:02:06 +01:00
Fredrik Adelöw da9cba20f2 add docs on how to add custom entity providers
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-01-26 10:06:47 +01:00
Alef 3847c6f7a7 docs: prettier
Signed-off-by: Alef <alef.carlos@gmail.com>
2022-01-25 14:20:57 -03:00
Erik Aaron Hansen 8e09fc712e Update writing-custom-actions.md
Signed-off-by: Erik Aaron Hansen <erikaaron.hansen@technipfmc.com>
2022-01-24 13:51:30 +01:00
Alef e50ddb1f72 docs: better naming
Signed-off-by: Alef <alef.carlos@gmail.com>
2022-01-20 17:06:56 -03:00
Fredrik Adelöw 72c51e8483 Merge pull request #9046 from kim5566/k8s/google-service-account-authprovider
Kubernetes plugin: Add a Google Service Account auth provider
2022-01-20 10:17:15 +01:00
kim5566 a56eb5242a update doc
Signed-off-by: kim5566 <28945404+kim5566@users.noreply.github.com>
2022-01-20 14:07:03 +11:00
kim5566 8cd1d9033d add new googleServiceAccount authProvider
Signed-off-by: kim5566 <28945404+kim5566@users.noreply.github.com>
2022-01-20 13:55:52 +11:00