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
+10 -11
View File
@@ -2,11 +2,12 @@
id: locations
title: BitBucket Locations
sidebar_label: Locations
description: Documentation on BitBucket location integration
description:
Integrating source code stored in BitBucket into the Backstage catalog
---
The BitBucket integration supports loading catalog entities from bitbucket.com
or a self-hosted BitBucket. Components can be added to
or a self-hosted BitBucket. Entities can be added to
[static catalog configuration](../../features/software-catalog/configuration.md),
or registered with the
[catalog-import](https://github.com/backstage/backstage/tree/master/plugins/catalog-import)
@@ -16,10 +17,8 @@ plugin.
integrations:
bitbucket:
- host: bitbucket.org
username:
$env: BITBUCKET_USERNAME
token:
$env: BITBUCKET_TOKEN
username: ${BITBUCKET_USERNAME}
token: ${BITBUCKET_TOKEN}
```
> Note: A public BitBucket provider is added automatically at startup for
@@ -31,12 +30,12 @@ you can list the BitBucket providers you want to fetch data from. Each entry is
a structure with up to four elements:
- `host`: The host of the BitBucket instance, e.g. `bitbucket.company.com`.
- `username`: The BitBucket username to use in API requests. If a username is
not supplied, anonymous access will be used.
- `token` (optional): An personal access token as expected by BitBucket. Either
an access token **or** a password may be supplied.
- `appPassword` (optional): The password for the BitBucket user. Either an
appPassword **or** an access token may be supplied.
an access token **or** a username + appPassword may be supplied.
- `username`: The BitBucket username to use in API requests. If neither a
username nor token are supplied, anonymous access will be used.
- `appPassword` (optional): The password for the BitBucket user. Only needed
when using `username` instead of `token`.
- `apiBaseUrl` (optional): The URL of the GitLab API. For self-hosted
installations, it is commonly at `https://<host>/api/v4`. For gitlab.com, this
configuration is not needed as it can be inferred.