From 3cc26f47d23609fd43ccceea0c69540672cb5c5f Mon Sep 17 00:00:00 2001 From: Taras Mankovski Date: Thu, 1 Oct 2020 20:20:38 -0400 Subject: [PATCH 1/2] Add information about app-config.development.local.yaml to Development Environment page --- docs/getting-started/development-environment.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/getting-started/development-environment.md b/docs/getting-started/development-environment.md index 154a959f85..200701946c 100644 --- a/docs/getting-started/development-environment.md +++ b/docs/getting-started/development-environment.md @@ -88,3 +88,14 @@ yarn create-plugin # Create a new plugin > See > [package.json](https://github.com/spotify/backstage/blob/master/package.json) > for other yarn commands/options. + +## Local configuration + +Backstage allows you to specify the configuration used while running the +application on your computer. Local configuration is read from +`app-config.development.local.yaml`. This file is ignored by Git, which means +that you can safely use it to reference secrets like GitHub tokens worrying +about these secrets inadvertently ending up in the Git repository. + +You can learn more about local configuration in +[Static Configuration in Backstage](../conf/) section. From 65a06ce1e8c5f7c807bc8166b9541850c58697c0 Mon Sep 17 00:00:00 2001 From: Taras Mankovski Date: Fri, 2 Oct 2020 08:06:04 -0400 Subject: [PATCH 2/2] Added feedback from @freben --- docs/getting-started/development-environment.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/development-environment.md b/docs/getting-started/development-environment.md index 200701946c..aa9aa0bde1 100644 --- a/docs/getting-started/development-environment.md +++ b/docs/getting-started/development-environment.md @@ -93,9 +93,12 @@ yarn create-plugin # Create a new plugin Backstage allows you to specify the configuration used while running the application on your computer. Local configuration is read from -`app-config.development.local.yaml`. This file is ignored by Git, which means -that you can safely use it to reference secrets like GitHub tokens worrying -about these secrets inadvertently ending up in the Git repository. +`app-config.local.yaml`. This file is ignored by Git, which means that you can +safely use it to reference secrets like GitHub tokens without worrying about +these secrets, inadvertently ending up in the Git repository. You do not need to +copy everything from the default config to the local config. +`app-config.local.yaml` will be merged with `app-config.yaml` and overwrite the +default app configs. -You can learn more about local configuration in +You can learn more about the local configuration in [Static Configuration in Backstage](../conf/) section.