From 2977f2473d9acae6f0a9ac47c0ece0af3d3573f3 Mon Sep 17 00:00:00 2001
From: Gary Niemen <65337273+garyniemen@users.noreply.github.com>
Date: Wed, 3 Aug 2022 16:53:49 +0200
Subject: [PATCH] roadmap_updates-techdocs_search
Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com>
---
docs/features/search/README.md | 4 ++++
docs/features/techdocs/README.md | 13 +++++++++----
docs/overview/roadmap.md | 16 ++--------------
3 files changed, 15 insertions(+), 18 deletions(-)
diff --git a/docs/features/search/README.md b/docs/features/search/README.md
index 618231a31e..21deffb3a0 100644
--- a/docs/features/search/README.md
+++ b/docs/features/search/README.md
@@ -21,6 +21,10 @@ Backstage Search lets you find the right information you are looking for in the
See the more detailed [architecture](./architecture.md) and [tech stack](./architecture.md#tech-stack).
+## Project roadmap
+
+No current plans.
+
## Supported
The following sections show the plugins and search engines currently supported by Backstage Search.
diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md
index 65cfafd464..3251451cce 100644
--- a/docs/features/techdocs/README.md
+++ b/docs/features/techdocs/README.md
@@ -30,16 +30,15 @@ Today, it is one of the core products in Spotify’s developer experience offeri
### Now
-With the Backstage 1.2 release, we have introduced the [TechDocs Addon Framework](https://backstage.io/blog/2022/05/13/techdocs-addon-framework) for augmenting the TechDocs experience at read-time.
-
-In addition to the framework itself, we have open sourced a **ReportIssue** Addon, helping you to create a feedback loop that drives up documentation quality and foster a documentation culture at your organization.
+No current plans.
### Next
-What can we do in TechDocs to help drive up documentation quality? We have many ideas, for example, a Trust Card with associated Trust Score and automatic triggering of documentation maintenance notifications.
+No current plans.
### Someday/Maybe
+- What can we do in TechDocs to help drive up documentation quality? We have many ideas, for example, a Trust Card with associated Trust Score and automatic triggering of documentation maintenance notifications.
- 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?
@@ -129,3 +128,9 @@ TechDocs packages:
- @backstage/plugin-techdocs-backend
- @backstage/plugin-techdocs-node
- @techdocs/cli
+
+**TechDocs Addon Framework**
+
+With the Backstage 1.2 release, we introduced the [TechDocs Addon Framework](https://backstage.io/blog/2022/05/13/techdocs-addon-framework) for augmenting the TechDocs experience at read-time.
+
+In addition to the framework itself, we open sourced a **ReportIssue** Addon, helping you to create a feedback loop that drives up documentation quality and foster a documentation culture at your organization.
diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md
index df242ed172..e65d5ada83 100644
--- a/docs/overview/roadmap.md
+++ b/docs/overview/roadmap.md
@@ -12,12 +12,12 @@ and the broader Backstage community.
The Backstage roadmap lays out both [“what's next”](#whats-next) and ["future
work"](#future-work). With "next" we mean features planned for release within
-the ongoing quarter from April through June 2022. With "future" we mean
+the ongoing quarter from July through September 2022. With "future" we mean
features on the radar, but not yet scheduled.
| [What's next](#whats-next) | [Future work](#future-work) |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| [Backstage Search 1.0](#search-1.0)
[Backend Services (MVP)](#backend-services-mvp)
[Backstage Security Audit](#backstage-security-audit)
[Backstage Threat Model](#backstage-threat-model)
[TechDocs Addon Framework](#techdocs-addon-framework)
[Software Catalog pagination](#software-catalog-pagination)
[More SIGs](#more-sigs) | Ease of onboarding
Composable Homepage 1.0
Creator experience
GraphQL
Telemetry |
+| [Backend Services (MVP)](#backend-services-mvp)
[Backstage Security Audit](#backstage-security-audit)
[Backstage Threat Model](#backstage-threat-model)
[Software Catalog pagination](#software-catalog-pagination)
[More SIGs](#more-sigs) | Ease of onboarding
Composable Homepage 1.0
Creator experience
GraphQL
Telemetry |
The long-term roadmap (12 - 36 months) is not detailed in the public roadmap.
Third-party contributions are also not currently included in the roadmap. Let us
@@ -30,10 +30,6 @@ The feature set below is planned for the ongoing quarter, and grouped by theme.
The list order doesn't necessarily reflect priority, and the development/release
cycle will vary based on maintainer schedules.
-### Backstage Search 1.0
-
-Fix the few remaining issues to get Backstage Search platform up to 1.0. For more information, see the [Backstage Search documentation and roadmap page](https://backstage.io/docs/features/search/search-overview).
-
### Backend Services (MVP)
To better scale and maintain the Backstage instances, a backend services system
@@ -72,14 +68,6 @@ The planned artifacts are:
- Concise high level threat model that will be included as part of the Backstage security documentation.
- Granular threat model created in conjunction with the security audit to inform further security investment areas for Backstage.
-### TechDocs Addon Framework
-
-Addons are TechDocs features that are added on top of the base docs-like-code experience. An example would be a feature that showed comments on the page. We plan to add an Addon framework and open source a selection of the Addons that we use internally at Spotify. We encourage the Backstage community to add further Addons.
-
-For more information about the TechDocs Addon Framework, see the documentation page [here](https://backstage.io/docs/features/techdocs/addons).
-
-For general information about TechDocs including roadmap, see [here](https://backstage.io/docs/features/techdocs/techdocs-overview).
-
### Software Catalog pagination
Today adopters with a big catalog (with several thousands of software components) might not have an ideal end-user experience when viewing the `/catalog` page. The issue is related to how the entities are fetched by the frontend. In order to provide a better end-user experience the pagination of the catalog’s entities needs to be enforced. Some experimentation is already completed but in this quarter we plan to continue, and hopefully complete, this relevant enhancement.