1. Use $file for googleGcs.credentials

2. Clarify that techdocs-common is only used in backend plugin since it is compiled to commonJS
This commit is contained in:
Himanshu Mishra
2020-12-09 20:09:51 +01:00
parent 24bcdd0829
commit 511f59f021
8 changed files with 28 additions and 29 deletions
+2 -1
View File
@@ -61,7 +61,8 @@ techdocs:
googleGcs:
# An API key is required to write to a storage bucket.
pathToKey: '/path/to/google_application_credentials.json',
credentials:
$file: '/path/to/google_application_credentials.json',
# Your GCP Project ID where the Cloud Storage Bucket is hosted.
projectId: 'gcp-project-id'
@@ -58,7 +58,7 @@ IAM & Admin console), and create a new key. Use JSON format for the key.
A `<GCP-PROJECT-ID-random-uid>.json` file will be downloaded. This is the secret
key TechDocs will use to make API calls. Make it available in your Backstage
server and/or your local development server and set it in the app config
`techdocs.publisher.googleGcs.pathToKey`.
`techdocs.publisher.googleGcs.credentials`.
```yaml
techdocs:
@@ -66,7 +66,8 @@ techdocs:
type: 'googleGcs'
googleGcs:
projectId: 'gcp-project-id'
pathToKey: '/path/to/google_application_credentials.json'
credentials:
$file: '/path/to/google_application_credentials.json'
```
**4. GCS Bucket**
@@ -83,7 +84,8 @@ techdocs:
type: 'googleGcs'
googleGcs:
projectId: 'gcp-project-id'
pathToKey: '/path/to/google_application_credentials.json'
credentials:
$file: '/path/to/google_application_credentials.json'
bucketName: 'name-of-techdocs-storage-bucket'
```