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 <bgrainger@gmail.com>
This commit is contained in:
Bradley Grainger
2022-10-01 20:33:06 -07:00
parent d4a8c683be
commit 94dbaf3645
+6
View File
@@ -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