From 53c7a9dbebf84e66a5a1dab102e7507f4b939285 Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 1 Jun 2021 17:15:48 +0200 Subject: [PATCH 1/2] docs: mention that the configuration is shared between the backend and the frontend Signed-off-by: blam --- docs/conf/writing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/conf/writing.md b/docs/conf/writing.md index c7b3bfe296..1924614dc5 100644 --- a/docs/conf/writing.md +++ b/docs/conf/writing.md @@ -6,8 +6,9 @@ description: Documentation on Writing Backstage Configuration Files ## File Format -Configuration is stored in YAML format in `app-config.yaml` files, looking -something like this: +Configuration is stored in YAML format in `app-config.yaml` files. This +configuration is shared between the frontend and backend and it looks something +like this: ```yaml app: From 6320b24bbbc5469c0bf28d8a3e0591c934da9711 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 1 Jun 2021 19:51:17 +0200 Subject: [PATCH 2/2] docs: add paragraph on how to view local config docs Signed-off-by: Patrik Oldsberg --- docs/conf/writing.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/conf/writing.md b/docs/conf/writing.md index 1924614dc5..4288d23b17 100644 --- a/docs/conf/writing.md +++ b/docs/conf/writing.md @@ -33,6 +33,15 @@ proxy: Configuration files are typically checked in and stored in the repo that houses the rest of the Backstage application. +The particular configuration that is available to each Backstage app depends on +what plugins and packages are installed. To view the configuration reference for +your own project, including what configuration keys available and whether they +are needed by the frontend, use the following command: + +```sh +yarn backstage-cli config:docs +``` + ## Environment Variable Overrides Individual configuration values can be overridden using environment variables