From 49280ffc3340857bf2cb697616abe7cdf083d824 Mon Sep 17 00:00:00 2001 From: Gary Niemen <65337273+garyniemen@users.noreply.github.com> Date: Fri, 1 Apr 2022 17:58:13 +0200 Subject: [PATCH 1/2] Update TechDocs roadmap page Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com> --- docs/features/techdocs/README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index 4417e62c67..b3cb8025ce 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -10,29 +10,20 @@ description: TechDocs is Spotify’s homegrown docs-like-code solution built dir -TechDocs is Spotify’s homegrown docs-like-code solution built directly into -Backstage. This means engineers write their documentation in Markdown files -which live together with their code. +TechDocs is Spotify’s homegrown docs-like-code solution built directly into Backstage. Engineers write their documentation in Markdown files which live together with their code - and with little configuration get a nice-looking doc site in Backstage. -Today, it is one of the core products in Spotify’s developer experience offering -with 2,400+ documentation sites and 1,000+ engineers using it daily. Read more -about TechDocs and the philosophy in its +Today, it is one of the core products in Spotify’s developer experience offering with 5000+ documentation sites and around 10000 average daily hits. Read more about TechDocs in its [announcement blog post](https://backstage.io/blog/2020/09/08/announcing-tech-docs). 🎉 ## Features - Deploy TechDocs no matter how your software environment is set up. -- Discover your Service's technical documentation from the Service's page in - Backstage Catalog. +- Discover your Service's technical documentation from the Service's page in Backstage Catalog. - Create documentation-only sites for any purpose by just writing Markdown. - Explore and take advantage of the large ecosystem of - [MkDocs plugins](https://www.mkdocs.org/user-guide/plugins/) to create a rich - reading experience. + [MkDocs plugins](https://www.mkdocs.org/user-guide/plugins/) to create a rich reading experience. - Search for and find docs. -- Highlight text and raise an Issue to create feedback loop to drive quality - documentation (future). -- Contribute to and deploy from a marketplace of TechDocs widgets (future). ## Platforms supported @@ -83,17 +74,22 @@ TechDocs packages: - '@backstage/plugin-techdocs-node' - '@techdocs/cli' -was promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy). +TechDocs promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy). ### **Future work 🔮** +Some of the following items are coming soon and some are potential ideas. + +- [TechDocs Addon Framework](https://github.com/backstage/backstage/issues/9636) +- Contribute to and deploy from a marketplace of TechDocs Addons +- Addon: Highlight text and raise an Issue to create a feedback loop to drive up documentation quality +- Addon: MDX (allows you to use JSX in your Markdown content) - Better integration with - [Scaffolder V2](https://github.com/backstage/backstage/issues/2771) (e.g. easy - to choose and plug documentation template with Software Templates). + [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 - Possible to configure several aspects about TechDocs (e.g. URL, homepage, - theme). -- [TechDocs Addon Framework](https://github.com/backstage/backstage/issues/9636) + theme) + ## Tech stack From 1b44c18d2922871006c4947180ad1a71533ea825 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Thu, 7 Apr 2022 10:25:22 +0200 Subject: [PATCH 2/2] Prettier Signed-off-by: Eric Peterson --- docs/features/techdocs/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index b3cb8025ce..340c0d9396 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -10,7 +10,7 @@ description: TechDocs is Spotify’s homegrown docs-like-code solution built dir -TechDocs is Spotify’s homegrown docs-like-code solution built directly into Backstage. Engineers write their documentation in Markdown files which live together with their code - and with little configuration get a nice-looking doc site in Backstage. +TechDocs is Spotify’s homegrown docs-like-code solution built directly into Backstage. Engineers write their documentation in Markdown files which live together with their code - and with little configuration get a nice-looking doc site in Backstage. Today, it is one of the core products in Spotify’s developer experience offering with 5000+ documentation sites and around 10000 average daily hits. Read more about TechDocs in its [announcement blog post](https://backstage.io/blog/2020/09/08/announcing-tech-docs). @@ -90,7 +90,6 @@ Some of the following items are coming soon and some are potential ideas. - Possible to configure several aspects about TechDocs (e.g. URL, homepage, theme) - ## Tech stack | Stack | Location |