From 6225350f24dc39555dcbb379155aa187d19cdd98 Mon Sep 17 00:00:00 2001 From: Gary Niemen <65337273+garyniemen@users.noreply.github.com> Date: Fri, 22 Apr 2022 16:47:33 +0200 Subject: [PATCH] Update TechDocs roadmap Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com> --- docs/features/techdocs/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index c64d0b785d..5ac275b8b4 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -82,13 +82,17 @@ With the Backstage 1.2 release, we plan to introduce the [TechDocs Addon Framewo In addition to the framework itself, we'll be open sourcing a `` addon, helping you to create a feedback loop that drives up documentation quality and fosters a documentation culture at your organization. -### **Future work 🔮** +### **Next** -Some of the following items are coming soon and some are potential ideas. +- What can we do in TechDocs to drive up documentation quality? +### **Someday/Maybe** + +- Contribute to and deploy from a marketplace of TechDocs Addons +- Addon: MDX (allows you to use JSX in your Markdown content) +- Can we go static site generator agnostic? - Better integration with - [Scaffolder V2](https://github.com/backstage/backstage/issues/2771) (e.g. easy to choose and plug documentation template with Software Templates) -- Static site generator agnostic, including possible support for MDX (allowing you to use JSX in your Markdown content) + [Scaffolder V2](https://github.com/backstage/backstage/issues/2771) (e.g. easy to choose and apply documentation template with Software Templates) - Possible to configure several aspects about TechDocs (e.g. URL, homepage, theme)