Commit Graph

124 Commits

Author SHA1 Message Date
Patrik Oldsberg 490a905199 docs: rename CLI section to Local Development + move in linking docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-09 11:41:37 +02:00
Patrik Oldsberg 670f79ded3 Apply suggestions from code review
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-04 23:19:23 +02:00
Patrik Oldsberg fddfb5e10f docs: migrate composability migration docs away from migration
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-01 18:55:09 +02:00
Michael Stergianis 252ffd7fdb Add api refrence to useEntity
Signed-off-by: Michael Stergianis <mstergianis@vmware.com>
2021-09-20 17:26:59 -04:00
Michael Stergianis d646407c76 Update plugin software catalog integration docs
Updates ./docs/plugins/integrating-plugin-into-software-catalog.md as
the docs had fallen out of date. Prefers educating plugin authors about
useEntity as that is the defacto method for reading entities. Takes the
author through an example of adding their plugin content to an existing
entity element.

Signed-off-by: Michael Stergianis <mstergianis@vmware.com>
Signed-off-by: Daniel Bravo <dbravo@vmware.com>
2021-09-16 14:50:11 -04:00
Ben Lambert dc8c571f57 Merge pull request #7195 from bolcom/composability-doc-fix
Small fix in the composability docs
2021-09-15 16:09:10 +02:00
Roy Jacobs 1491c5e979 Small fix in the composability docs
Signed-off-by: Roy Jacobs <roy.jacobs@gmail.com>
2021-09-15 15:26:07 +02:00
Patrik Oldsberg e65c42aa77 docs: fix reference links
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 15:41:29 +02:00
Brian Fletcher dc0b9cc7a9 Merge remote-tracking branch 'origin' into github-installations-limit 2021-08-06 13:30:56 +01:00
Brian Fletcher 5927bf864f Makes some suggested documentation improvements
Signed-off-by: Brian Fletcher <brian@roadie.io>
2021-08-06 10:23:58 +01:00
Himanshu Mishra 47029e79a0 docs: run prettier
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-21 09:08:23 +02:00
daftgopher 442e1a52b8 Minor text agreement correction
Signed-off-by: daftgopher <daftgopher@users.noreply.github.com>
2021-07-20 23:10:12 -04:00
Brian Fletcher e1178b4361 update github readme to include owners filter
Signed-off-by: Brian Fletcher <brian@roadie.io>
2021-07-14 08:59:09 +01:00
Brian Fletcher a5d112ef49 Merge branch 'master' into github-installations-limit 2021-07-14 08:03:08 +01:00
Himanshu Mishra 19b459d2ba move url reader docs to plugins -> backend apis
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-05 14:46:04 +02:00
Fredrik Adelöw 4666577b53 Merge pull request #6141 from backstage/software-catalog-rename
Docs: Update references to "service catalog"
2021-06-28 13:47:16 +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
Joe Porpeglia 709589a839 Rename service catalog to software catalog, excluding blog posts
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2021-06-21 11:48:43 -04:00
Rogerio Angeliski 953a7e66f9 feat: update plugin path to match same behavior in the main app
resolves #6108

Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2021-06-18 18:08:56 -03:00
Ben Lambert ffe7759de8 Merge pull request #6049 from backstage/timbonicus/move-installation
Move `catalog` and `scaffolder` installation instructions to READMEs
2021-06-17 15:14:07 +02:00
Patrik Oldsberg e3d31b3815 cli: disable GitHub App webhook by default
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 13:26:11 +02:00
Bryan Lam 81ec239bb1 Fix backend-plugin document typo
Signed-off-by: Bryan Lam <bryan.s.lam@gmail.com>
2021-06-16 23:24:38 -07:00
Tim Hansen 785a42f802 Move installation instructions to READMEs
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-06-15 15:00:15 -06:00
Brian Fletcher 5fa0c32bff Fixes some typos in changeset and docs
Signed-off-by: Brian Fletcher <brian@roadie.io>
2021-06-14 14:16:13 +01:00
Brian Fletcher 68af4d556b Add allowedInstallationIds list to each github app
This allows a single instance of backstage to optionally limit the set of
github app installations that may be used by backstage.

Previously, if you had github app installations for tenant1 and tenant2
there was nothing stopping the first from accessing resources of the
second.

The default behaviour of the GithubCredentialsProvider remains the same.

Signed-off-by: Brian Fletcher <brian@roadie.io>
2021-06-14 14:04:51 +01:00
Fredrik Adelöw 2b13540015 Some quick docs on how to interface with databases from backend plugins
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-06-10 19:24:48 +02:00
Fredrik Adelöw b4fadeceea fill in the backend docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-05-20 13:38:21 +02:00
Fredrik Adelöw b99ac3f6e1 Minor composability etc docs changes
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-05-02 22:13:05 +02:00
Fredrik Adelöw 50a3012f8c Merge pull request #5490 from onematchfox/fix/proxy-config-env-vars
Remove requirement for proxy routes to be prefixed with `/`
2021-04-29 16:55:58 +02:00
Brian Fox cdb3426e56 fix(proxy-backend): prefix routes with / if not present in config
This commit ensures that the default `pathRewrite` configuration for a proxy element is more resilient to the combination of whether:
- `route` is prefixed with `/`
- `pathPrefix` on the plugin is suffixed with `/` (which at present it will never be - see comments).

Signed-off-by: Brian Fox <brianhfox@gmail.com>
2021-04-27 12:40:15 +02:00
Patrik Oldsberg c614ede9a5 docs: update plugin installation docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-22 18:32:54 +02:00
Brett Wright 1334c7868c Added doco regarding Datadog installation
Signed-off-by: Brett Wright <brett.wright@bestseller.com>
Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:15 +02:00
Fredrik Adelöw c28689c686 change all $env to ${}
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-15 13:26:44 +02:00
Fidel Coria 25554bad3b docs(composability): subroutes example
Signed-off-by: Fidel Coria <fidel.coria@aa.com>
2021-03-18 10:27:46 -05:00
Oliver Sand 9f39dc9270 Fix missing closing tag in source code examples
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-03-16 17:53:29 +01:00
Patrik Oldsberg 2c9c165b2e docs/plugins/composability: added docs for SubRouteRefs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-03-08 19:14:41 +01:00
Johan Haals a8eb2b45e3 microsite: Add GitHub Apps documentation
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-03-02 09:25:01 +01:00
Patrik Oldsberg 243dd5771b Apply suggestions from code review
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-02-25 19:08:04 +01:00
Patrik Oldsberg 0bb18ad79d docs: document optional external route refs 2021-02-25 17:48:31 +01:00
r.bideau 24b59505d0 Moves google analytics docs in an integration section
- with a link to it in the observability page.
- documents the default behavior and add a link to the GA developer guides

Signed-off-by: r.bideau <7304827+rbideau@users.noreply.github.com>
2021-02-21 20:41:44 +01:00
Adam Harvey ba99544da6 Fix filename escaping 2021-02-17 22:34:20 -05:00
Adam Harvey 633416f5e6 Fix typo 2021-02-16 09:38:09 -05:00
Adam Harvey 6d6a5d6dfc Fix prettier line lengths 2021-02-16 09:32:34 -05:00
Adam Harvey 6736a0fdf2 Editorial changes 2021-02-16 09:12:50 -05:00
Ben Lambert 37ff639dbd Merge pull request #4533 from ebarriosjr/fixing-github-apps-docs-yaml
Fixing GitHub apps docs yaml
2021-02-15 15:02:43 +01:00
ebarrios bdf5c24328 The apps entry in the yaml file need to be at the same level as the host, if it is not the app will not start and complain about it 2021-02-15 14:50:44 +01:00
Johan Haals 8b8e9d1e9a Export createExternalRouteRef and set id
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: blam<ben@blam.sh>
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-02-15 11:59:32 +01:00
Fredrik Adelöw 246c9c6edc Update docs/plugins/observability.md
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-02-02 11:07:51 +01:00
Fredrik Adelöw 77fe4ef3cd docs: add a miniature article about observability 2021-02-01 17:09:03 +01:00
Patrik Oldsberg 58a28f0b87 docs: update plugin create and reference docs for top-level routable extensions 2021-01-31 21:39:05 +01:00