From 7ed480774878ecf0ac7cd3ec1526c2ebad88cf1b Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Mon, 11 Jan 2021 21:05:23 +0100 Subject: [PATCH] 1. docs: Rephrase setting the config 2. Update changeset with info about removing projectId from googleGcs config --- .changeset/heavy-owls-float.md | 8 +++++--- docs/features/techdocs/using-cloud-storage.md | 3 ++- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.changeset/heavy-owls-float.md b/.changeset/heavy-owls-float.md index 1997e64d72..274876e723 100644 --- a/.changeset/heavy-owls-float.md +++ b/.changeset/heavy-owls-float.md @@ -5,6 +5,8 @@ Google Cloud authentication in TechDocs has been improved. -`techdocs.publisher.googleGcs.credentials` is now optional. If it is missing, `GOOGLE_APPLICATION_CREDENTIALS` -environment variable (and some other methods) will be used to authenticate. -Read more here https://cloud.google.com/docs/authentication/production +1. `techdocs.publisher.googleGcs.credentials` is now optional. If it is missing, `GOOGLE_APPLICATION_CREDENTIALS` + environment variable (and some other methods) will be used to authenticate. + Read more here https://cloud.google.com/docs/authentication/production + +2. `techdocs.publisher.googleGcs.projectId` is no longer used. You can remove it from your `app-config.yaml`. diff --git a/docs/features/techdocs/using-cloud-storage.md b/docs/features/techdocs/using-cloud-storage.md index 7be977887b..474d9d64e6 100644 --- a/docs/features/techdocs/using-cloud-storage.md +++ b/docs/features/techdocs/using-cloud-storage.md @@ -37,7 +37,8 @@ techdocs-backend will publish documentation to this bucket. TechDocs will fetch files from here to serve documentation in Backstage. Note that the bucket names are globally unique. -Set the name of the bucket to `techdocs.publisher.googleGcs.bucketName`. +Set the config `techdocs.publisher.googleGcs.bucketName` in your +`app-config.yaml` to the name of the bucket you just created. ```yaml techdocs: