Commit Graph

844 Commits

Author SHA1 Message Date
Gediminas dd131d95be docs: update custom field extensions writing guide
Signed-off-by: Gediminas <gediminasgn@gmail.com>
2022-03-25 10:25:46 +01:00
Johan Haals 69c864956b Merge pull request #10326 from daftgopher/template_migration_doc_edit
Add template migration documentation regarding dash-case action ids
2022-03-21 09:03:27 +01:00
Emma Indal b52529e95d Merge pull request #10252 from backstage/emmaindal/update-techdocs-documentation
[TechDocs] update documentation
2022-03-20 21:08:51 +01:00
daftgopher bd4aac9c80 additional template migration documentation
Signed-off-by: daftgopher <daftgopher@users.noreply.github.com>
2022-03-19 17:15:32 -04:00
Johan Haals 45153b3b08 Merge pull request #10239 from getndazn/fix/github-workflow-scope
replacing workflow:write scope with workflow, workflow:write is invalid.
2022-03-18 10:40:03 +01:00
Emma Indal 6f2b6a804a fixups
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-03-17 10:16:36 +01:00
Emma Indal be260c99ab remove deprecated config documentation
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-03-17 10:14:57 +01:00
Emma Indal d50fbeddc1 update roadmap docs
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-03-17 10:14:36 +01:00
Marco Crivellaro e0308ca6ec replacing workflow:write scope with workflow, workflow:write is invalid.
Signed-off-by: Marco Crivellaro <marco.crive@gmail.com>
2022-03-16 17:19:26 +00:00
Patrik Oldsberg c689d7a94c catalog: group, rename, and move filter components to catalog-react
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-03-16 15:10:41 +01:00
Johan Haals ab4d602942 microsite: remove outdated labels
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-03-16 10:28:00 +01:00
Fredrik Adelöw 6565f2c50b Merge pull request #10147 from rex4539/typos
Fix typos
2022-03-15 11:01:46 +01:00
Fredrik Adelöw 23974ceeb0 Merge pull request #10195 from backstage/freben/processingResult
removed a lingering reference to the old 'result' export
2022-03-15 11:00:57 +01:00
Emma Indal fe6814471a Merge pull request #10174 from backstage/emmaindal/techdocs-clean-up-deprecations
[TechDocs] clean up deprecations
2022-03-15 11:00:17 +01:00
Fredrik Adelöw a13f70dc89 removed a lingering reference to the old 'result' export
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-03-15 09:40:35 +01:00
Emma Indal 7cb5788e9c clean up deprecations of techdocs plugin
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-03-14 22:39:17 +01:00
djamaile 41f51ad5d5 docs: write on how to use feature flags within templates
Signed-off-by: djamaile <rdjamaile@gmail.com>
2022-03-14 19:06:32 +01:00
Kyle Smith 869a775f26 Update TechDocs getting started to match create-app.
Closes #10133.

Signed-off-by: Kyle Smith <kyle.smith@salsify.com>
2022-03-14 13:14:51 +01:00
Fredrik Adelöw 18b03f031b Merge pull request #10150 from backstage/freben/plugin-head
make the backend plugin ts files consistent
2022-03-14 11:04:07 +01:00
Johan Haals 78e95df160 Merge pull request #9918 from RoadieHQ/add-new-actions
Add link to new actions
2022-03-14 09:46:07 +01:00
Fredrik Adelöw 89c7e47967 make the backend plugin ts files consistent
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-03-13 19:27:46 +01:00
Dimitris Apostolou aedd4daa66 Fix typos
Signed-off-by: Dimitris Apostolou <dimitris.apostolou@icloud.com>
2022-03-13 14:12:05 +02:00
Andre Wanlin 8d081c3f3b Fixed typo and updated code examples
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2022-03-12 10:51:29 -06:00
Fredrik Adelöw 165cabfeb6 Merge pull request #9976 from backstage/freben/generation
remove `metadata.generation`
2022-03-10 15:45:21 +01:00
blam 6049d33313 chore: updating this in documentation though too
Signed-off-by: blam <ben@blam.sh>
2022-03-09 10:08:50 +01:00
blam 5625443a26 chore: added a note in the migration sheet
Signed-off-by: blam <ben@blam.sh>
2022-03-08 15:07:41 +01:00
blam 592ac178ec chore: updating documentation and removing the last of v1beta2
Signed-off-by: blam <ben@blam.sh>
2022-03-08 14:26:03 +01:00
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
Fredrik Adelöw 02ad19d189 remove metadata.generation
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-03-04 11:17:24 +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
Kiss Miklos 9135b66f32 add links to new roadie actions
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-03-02 19:16:37 +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