From 94dbaf364590ce6c9b804ee1fdbf13fb65ffb951 Mon Sep 17 00:00:00 2001 From: Bradley Grainger Date: Sat, 1 Oct 2022 20:33:06 -0700 Subject: [PATCH] Document host attribute for github catalog provider. This was added in https://github.com/backstage/backstage/pull/13400 but isn't documented yet. Signed-off-by: Bradley Grainger --- docs/integrations/github/discovery.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index 6966753d68..6acb87ac37 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -96,6 +96,10 @@ catalog: topic: include: ['backstage-include'] # optional array of strings exclude: ['experiments'] # optional array of strings + enterpriseProviderId: + host: ghe.example.net + organization: 'backstage' # string + catalogPath: '/catalog-info.yaml' # string ``` This provider supports multiple organizations via unique provider IDs. @@ -125,6 +129,8 @@ This provider supports multiple organizations via unique provider IDs. - **organization**: Name of your organization account/workspace. If you want to add multiple organizations, you need to add one provider config each. +- **host** _(optional)_: + The hostname of your GitHub Enterprise instance. It must match a host defined in [integrations.github](locations.md). ## GitHub API Rate Limits