TechDocs: Add visbility to migrate away from basic setup

jeremyguarini · Feb 6, 2021 · f4b576d · f4b576d
1 parent e125f46
commit f4b576d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/.changeset/metal-monkeys-do.md b/.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
diff --git a/app-config.yaml b/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:

diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/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: