Update descriptions, remove $env, wording tweaks

Signed-off-by: Tim Hansen <timbonicus@gmail.com>
This commit is contained in:
Tim Hansen
2021-03-24 10:50:28 -06:00
parent d35fd7845b
commit 8d88ba28ea
8 changed files with 39 additions and 46 deletions
+3 -1
View File
@@ -2,7 +2,9 @@
id: discovery
title: GitHub Discovery
sidebar_label: Discovery
description: Documentation on GitHub organization discovery
description:
Automatically discovering catalog entities from repositories in a GitHub
organization
---
The GitHub integration has a special discovery processor for discovering catalog
+5 -7
View File
@@ -2,11 +2,11 @@
id: locations
title: GitHub Locations
sidebar_label: Locations
description: Documentation on GitHub location integration
description: Integrating source code stored in GitHub into the Backstage catalog
---
The GitHub integration supports loading catalog entities from github.com or
GitHub Enterprise. Components can be added to
GitHub Enterprise. Entities can be added to
[static catalog configuration](../../features/software-catalog/configuration.md),
registered with the
[catalog-import](https://github.com/backstage/backstage/tree/master/plugins/catalog-import)
@@ -21,13 +21,11 @@ To use this integration, add configuration to your root `app-config.yaml`:
integrations:
github:
- host: github.com
token:
$env: GITHUB_TOKEN
token: ${GITHUB_TOKEN}
- host: ghe.example.net
apiBaseUrl: https://ghe.example.net/api/v3
rawBaseUrl: https://ghe.example.net/raw
token:
$env: GHE_TOKEN
token: ${GHE_TOKEN}
```
> Note: A public GitHub provider is added automatically at startup for
@@ -52,7 +50,7 @@ data from. Each entry is a structure with up to four elements:
with this provider, specify the base URL for its endpoint here, with no
trailing slash. Specifically when the target is public GitHub, you can leave
it out to be inferred automatically. For a GitHub Enterprise installation, it
is commonly at `https://api.<host>` or `https://<host>/api/v3`.
is commonly at `https://<host>/raw`.
You need to supply either `apiBaseUrl` or `rawBaseUrl` or both (except for
public GitHub, for which we can infer them). The `apiBaseUrl` will always be
+2 -3
View File
@@ -3,7 +3,7 @@ id: org
title: GitHub Organizational Data
sidebar_label: Org Data
# prettier-ignore
description: Setting up ingestion of organizational data from GitHub
description: Importing users and groups from a GitHub organization into Backstage
---
The Backstage catalog can be set up to ingest organizational data - teams and
@@ -46,8 +46,7 @@ catalog:
providers:
- target: https://github.com
apiBaseUrl: https://api.github.com
token:
$env: GITHUB_TOKEN
token: ${GITHUB_TOKEN}
```
Locations point out the specific org(s) you want to import. The `type` of these