From de6b94e23695581c5786c9a3b6232f2a42518a19 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 30 Jul 2021 12:54:30 +0200 Subject: [PATCH 1/3] create-app: update app config to use the latest techdocs.generator option See https://backstage.io/docs/features/techdocs/configuration PR https://github.com/backstage/backstage/pull/6071 Signed-off-by: Himanshu Mishra --- packages/create-app/templates/default-app/app-config.yaml.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs index 0878bbab65..dc296e5e62 100644 --- a/packages/create-app/templates/default-app/app-config.yaml.hbs +++ b/packages/create-app/templates/default-app/app-config.yaml.hbs @@ -60,8 +60,8 @@ proxy: # https://backstage.io/docs/features/techdocs/how-to-guides#how-to-migrate-from-techdocs-basic-to-recommended-deployment-approach techdocs: builder: 'local' # Alternatives - 'external' - generators: - techdocs: 'docker' # Alternatives - 'local' + generator: + runIn: 'docker' # Alternatives - 'local' publisher: type: 'local' # Alternatives - 'googleGcs' or 'awsS3'. Read documentation for using alternatives. From 11c47adcddfaee534de51d11cbb7df9f0ae9d125 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 30 Jul 2021 12:54:51 +0200 Subject: [PATCH 2/3] docs/techdocs: Indicate optional configs explicitly Signed-off-by: Himanshu Mishra --- docs/features/techdocs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/techdocs/configuration.md b/docs/features/techdocs/configuration.md index ef6a80d44c..4bb6857106 100644 --- a/docs/features/techdocs/configuration.md +++ b/docs/features/techdocs/configuration.md @@ -24,13 +24,13 @@ techdocs: runIn: 'docker' - # techdocs.generator.dockerImage can be used to control the docker image used during documentation generation. This can be useful + # (Optional) techdocs.generator.dockerImage can be used to control the docker image used during documentation generation. This can be useful # if you want to use MkDocs plugins or other packages that are not included in the default techdocs-container (spotify/techdocs). # NOTE: This setting is only used when techdocs.generator.runIn is set to 'docker'. dockerImage: 'spotify/techdocs' - # techdocs.generator.pullImage can be used to disable pulling the latest docker image by default. This can be useful when you are + # (Optional) techdocs.generator.pullImage can be used to disable pulling the latest docker image by default. This can be useful when you are # using a custom techdocs.generator.dockerImage and you have a custom docker login requirement. For example, you need to login to # AWS ECR to pull the docker image. # NOTE: Disabling this requires the docker image was pulled by other means before running the techdocs generator. From 98dda80b4a867d4b5657b0632be1cba16b152be4 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 30 Jul 2021 12:57:48 +0200 Subject: [PATCH 3/3] create-app: add changeset for the techdocs config update Signed-off-by: Himanshu Mishra --- .changeset/techdocs-spicy-icons-explode.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .changeset/techdocs-spicy-icons-explode.md diff --git a/.changeset/techdocs-spicy-icons-explode.md b/.changeset/techdocs-spicy-icons-explode.md new file mode 100644 index 0000000000..7a532c0323 --- /dev/null +++ b/.changeset/techdocs-spicy-icons-explode.md @@ -0,0 +1,7 @@ +--- +'@backstage/create-app': patch +--- + +Update `techdocs.generators` with the latest `techdocs.generator` config in `app-config.yaml`. See +https://backstage.io/docs/features/techdocs/configuration for reference and relevant PR +https://github.com/backstage/backstage/pull/6071/files for the changes.