Merge pull request #4413 from backstage/orkohunter/visbility-to-techdocs-recommended

TechDocs: Add visibility to migrate away from basic setup

.changeset/metal-monkeys-do.md

@@ -0,0 +1,5 @@
+---
+'@backstage/create-app': patch
+---
+
+TechDocs: Add comments about migrating away from basic setup in app-config.yaml

app-config.yaml

@@ -73,6 +73,9 @@ organization:
   name: My Company
 
 # Reference documentation http://backstage.io/docs/features/techdocs/configuration
+# Note: After experimenting with basic setup, use CI/CD to generate docs
+# and an external cloud storage when deploying TechDocs for production use-case.
+# 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:

packages/create-app/templates/default-app/app-config.yaml.hbs

@@ -57,6 +57,9 @@ proxy:
     changeOrigin: true
 
 # Reference documentation http://backstage.io/docs/features/techdocs/configuration
+# Note: After experimenting with basic setup, use CI/CD to generate docs
+# and an external cloud storage when deploying TechDocs for production use-case.
+# 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: