TechDocs: Add visbility to migrate away from basic setup

2021-02-06 14:19:34 +01:00
parent e125f46460
commit f4b576d0e2
3 changed files with 11 additions and 0 deletions
@@ -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: