paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 52 Packages Projects Releases Wiki Activity

Merge pull request #6665 from backstage/orkohunter/techdocs-update-config-for-create-app-template

Browse Source 
techdocs/create-app: update app config to use the latest techdocs.generator option
This commit is contained in:
Ben Lambert
2021-08-02 18:06:13 +02:00
committed by GitHub
parent 64429fc4c6 98dda80b4a
commit c0146e959b
3 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/techdocs-spicy-icons-explode.md
+7
View File
@@ -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.
docs/features/techdocs/configuration.md
+2 -2
View File
@@ -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.
packages/create-app/templates/default-app/app-config.yaml.hbs
+2 -2
View File
@@ -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.