From d50fbeddc1ebdd1265f20929cf356aacf6c0a595 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Thu, 17 Mar 2022 10:14:36 +0100 Subject: [PATCH 1/3] update roadmap docs Signed-off-by: Emma Indal --- docs/features/techdocs/README.md | 32 +++++++++++--------------- docs/features/techdocs/architecture.md | 12 ---------- 2 files changed, 13 insertions(+), 31 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index d5aad1c541..94d6ba3bd9 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -74,32 +74,26 @@ providers are used. storage solutions, source control systems). - [Instructions for upgrading from Alpha to Beta](how-to-guides.md#how-to-migrate-from-techdocs-alpha-to-beta) +**v1** ✅ + +TechDocs packages + +- '@backstage/plugin-techdocs' +- '@backstage/plugin-techdocs-backend' +- '@backstage/plugin-techdocs-node' +- '@techdocs/cli' + +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 🔮** -**General Availability (GA) release** - -[Milestone](https://github.com/backstage/backstage/milestone/30) - -- Bugs are rare, TechDocs APIs are stable and scales easily in large - organizations. - 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 - Possible to configure several aspects about TechDocs (e.g. URL, homepage, theme). - -**Implement Feedback loop** - -[Milestone](https://github.com/backstage/backstage/milestone/31) - -- A feedback loop between documentation reader and writer using TechDocs -- The `+` in `docs-like-code+` experience - -**TechDocs widget framework** - -Platformize TechDocs with a widget framework so that it is easy for TechDocs -contributors to add pieces of functionality and for users to choose which -functionalities they want to adopt. As a pre-requisite, the re-architecture of -TechDocs frontend [RFC](https://github.com/backstage/backstage/issues/3998) -needs to be addressed. +- [TechDocs Addon Framework](https://github.com/backstage/backstage/issues/9636) ## Tech stack diff --git a/docs/features/techdocs/architecture.md b/docs/features/techdocs/architecture.md index 23af83d09b..d781f71917 100644 --- a/docs/features/techdocs/architecture.md +++ b/docs/features/techdocs/architecture.md @@ -131,15 +131,3 @@ layer for users to determine whether they have the permission to view a particular docs site. There are a handful of features which are extremely hard to develop without a tightly integrated backend in place. Hence, support for `techdocs` without `techdocs-backend` is limited and challenging to develop. - -# Future work - -_Ideas here are far fetched and not in the project's milestone for near future -(~6 months)._ - -We currently depend on MkDocs to parse doc sites written in Markdown. And we -store the generated static assets and re-use it later to render in Backstage. A -better (futuristic) approach will be to directly parse whatever type of source -files you have in your docs repository and directly render in Backstage in -real-time. You can read more in this -[RFC - Simplifying TechDocs Frontend Architecture](https://github.com/backstage/backstage/issues/3998). From be260c99ab33e538b3586c57e09243efc730c7ef Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Thu, 17 Mar 2022 10:14:57 +0100 Subject: [PATCH 2/3] remove deprecated config documentation Signed-off-by: Emma Indal --- docs/features/techdocs/configuration.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/features/techdocs/configuration.md b/docs/features/techdocs/configuration.md index d16e9142dc..a3f4723173 100644 --- a/docs/features/techdocs/configuration.md +++ b/docs/features/techdocs/configuration.md @@ -160,10 +160,4 @@ techdocs: # object was not found (e.g. when the cache sercice is unavailable). The # default value is 1000 readTimeout: 500 - - # (Optional and Legacy) Just another route in techdocs-backend where TechDocs requests the static files from. This URL uses an HTTP middleware - # to serve files from either a local directory or an External storage provider. - # You don't have to specify this anymore. - - storageUrl: http://localhost:7007/api/techdocs/static/docs ``` From 6f2b6a804a68f6604929fa60b59271dcd3cc34ec Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Thu, 17 Mar 2022 10:16:36 +0100 Subject: [PATCH 3/3] fixups Signed-off-by: Emma Indal --- docs/features/techdocs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index 94d6ba3bd9..4417e62c67 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -76,14 +76,14 @@ providers are used. **v1** ✅ -TechDocs packages +TechDocs packages: - '@backstage/plugin-techdocs' - '@backstage/plugin-techdocs-backend' - '@backstage/plugin-techdocs-node' - '@techdocs/cli' -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). +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). ### **Future work 🔮**