Commit Graph

1983 Commits

Author SHA1 Message Date
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
Patrik Oldsberg 3b6a06cdff Merge pull request #9858 from marcus-crane/update-postgres-tutorial-ssl
fix(docs): Update Postgres tutorial SSL block to match current Postgres template config
2022-03-03 14:34:41 +01:00
Patrik Oldsberg 0513a72032 Revert "scripts/prepare-release: update to detect patch versions from patch branches"
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-03-03 13:51:05 +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
Patrik Oldsberg a2dc1010c6 Merge pull request #9885 from backstage/rugvip/etbdocs
docs/local-dev: add docs for the experimental type build
2022-03-02 17:13:00 +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 efa549c4ab form refs properly in resolver docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-03-02 13:47:03 +01:00
Fredrik Adelöw abc66904b1 Merge pull request #9856 from backstage/freben/catalog-rearrange
Rearrange a bit inside the catalog backend
2022-03-02 11:05:49 +01:00
Phil Kuang 9a0510144f refactor(redis): require protocol in connection string
Signed-off-by: Phil Kuang <pkuang@factset.com>
2022-03-01 18:21:32 -05:00
Patrik Oldsberg 8dc290872d docs/local-dev: add docs for the experimental type build
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-03-01 17:57:13 +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
Marcus Crane abc91a6843 Update Postgres tutorial SSL block to match Postgres app config template
Signed-off-by: Marcus Crane <marcus.crane@lightspeedhq.com>
2022-03-01 09:13:15 +13: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 766f969de9 scripts/prepare-release: update to detect patch versions from patch branches
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-26 20:52:44 +01:00
Callen Barton 336cea247c Fixing typo. Changing Github to Azure
Signed-off-by: Callen Barton <7515844+cal5barton@users.noreply.github.com>
2022-02-24 17:45:51 -07:00
Fredrik Adelöw 043e1568e2 Merge pull request #9731 from zoefkip/patch-1
[docs] small typo in bitbucket auth provider docs
2022-02-23 16:15:52 +01:00
Fredrik Adelöw 086b1b1694 Merge pull request #9739 from magnusp/cachemanager-redis-client
backend-common: add Redis backed cache store
2022-02-23 15:43:32 +01:00
Fredrik Adelöw c37252f2ae Merge pull request #9663 from backstage/rugvip/moveloco
catalog-model: move LocationSpec to catalog-backend
2022-02-23 15:15:50 +01:00
Magnus Persson 7d12e4cf32 backend-common: add Redis backed cache store
Signed-off-by: Magnus Persson <magnus.persson@fortnox.se>
2022-02-22 22:29:28 +01:00
zoefkip 43da908ca6 small typo in bitbucket auth provider docs 2022-02-22 15:53:35 +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 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
Ben Lambert 9dfffc1558 Merge pull request #9626 from backstage/rugvip/pubfix
docs/publishing: minor tweak to master commit creation flow
2022-02-18 14:00:11 +01:00
Ben Lambert 7648bd08bc Merge pull request #9583 from lorsatti/master
Update Dockerfile to node:16-bullseye-slim, add sqlite3 dependencies
2022-02-18 10:40:34 +01:00
Patrik Oldsberg 78bff9f4c6 docs/publishing: minor tweak to master commit creation flow
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-17 17:53:04 +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
Lorenzo Orsatti f39c1e6036 update Dockerfile to node:16-bullseye-slim, add sqlite3 dependencies
Signed-off-by: Lorenzo Orsatti <49567430+lorsatti@users.noreply.github.com>
2022-02-17 12:20:01 +01:00
Patrik Oldsberg 010df9c0cf Merge pull request #9585 from backstage/timbonicus/github-scopes
Better GitHub scope/permission documentation
2022-02-17 10:26:18 +01:00
Fredrik Adelöw 240c3a54ed Merge pull request #9586 from backstage/timbonicus/demphasize-replacement
De-emphasize replaceProcessors in GitHub org doc
2022-02-17 10:07:12 +01:00
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
Tim Hansen 5ee1def55d De-emphasize replaceProcessors in GitHub org doc
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2022-02-16 13:55:01 -07:00
Tim Hansen 25889e1dea Better GitHub scope/permission documentation
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2022-02-16 13:38:52 -07: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 e4709d570e Merge pull request #9394 from backstage/orkohunter/homepage-getting-started
Docs: Tutorial on adding a Backstage home page
2022-02-16 12:43:41 +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
Patrik Oldsberg 80c627d098 Merge pull request #9490 from backstage/rugvip/maps
cli: add test source maps and update docs
2022-02-14 21:48:50 +01:00
Patrik Oldsberg 70f9655034 docs: add suggestion to disable full test runs in Jest editor integration
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-14 20:53:52 +01:00
Patrik Oldsberg a929ef20d3 Merge pull request #9513 from backstage/rugvip/authdocs
docs: tweak auth docs and add new ScmAuthApi section + link from error
2022-02-14 16:05:34 +01:00
Patrik Oldsberg baf9097e2c docs: fix auth doc spleling
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-14 15:37:58 +01:00