From 75d8a17466643c3a2fe82c39fdd1e7ec273abb21 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 20 May 2022 10:46:08 +0200 Subject: [PATCH] format with prettier Signed-off-by: Johan Haals --- docs/features/search/README.md | 14 ++++++-------- docs/features/techdocs/README.md | 4 ++-- docs/overview/roadmap.md | 4 ++-- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/docs/features/search/README.md b/docs/features/search/README.md index f5209e4627..f1744d4d80 100644 --- a/docs/features/search/README.md +++ b/docs/features/search/README.md @@ -41,17 +41,16 @@ stable. ### Next -*Not specified* +_Not specified_ ### Someday/Maybe -*Not specified* +_Not specified_ ### Done See [Done](#done) below for a list of completed roadmap items. - ## Supported The following sections show the search engines and plugins currently supported by Backstage Search. @@ -72,9 +71,9 @@ search engines. ### Plugins integrated with Backstage Search -| Plugin | Support Status | +| Plugin | Support Status | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | -| Software Catalog | ✅ | +| Software Catalog | ✅ | | [TechDocs](./how-to-guides.md#how-to-index-techdocs-documents) | ✅ | | [Stack Overflow](https://github.com/backstage/backstage/blob/master/plugins/stack-overflow-backend/README.md#index-stack-overflow-questions-to-search) | ✅ | @@ -118,7 +117,7 @@ there by means of a front-end only, non-extensible MVP. lifecycle) when I’ve performed a search. - As a software engineer I should be able to hide the filters if I don’t need to use them. - + **Backstage Search Alpha** Basic “out-of-the-box” in-memory indexing process of entities, and their metadata, registered to the Software Catalog. @@ -138,7 +137,7 @@ met, but built on top of a flexible, extensible platform. having to set up and configure a search engine. **Backstage Search Beta** - + At least one production-ready search engine that supports the same use-cases as in the alpha. We will consider Backstage Search to be in a beta phase when the above use-cases @@ -152,4 +151,3 @@ are met, and can be deployed using a production-ready search engine. - As an integrator, I should be able to tune the queries sent to my chosen search engine according to my organization's needs, but a sensible default query should be in place so that I am not required to do so. - diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index f0b77728b6..48c469def7 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -83,8 +83,8 @@ See [TechDocs Architecture](architecture.md) to get an overview of where the bel ## Tech stack -| Stack | Location | -| ----------------------------------------------- | --------------------------------------------------------------- | +| Stack | Location | +| ----------------------------------------------- | ------------------------------------------------------------- | | Frontend Plugin | [@backstage/plugin-techdocs][techdocs/frontend] | | Frontend Plugin Library | [@backstage/plugin-techdocs-react][techdocs/frontend-library] | | Backend Plugin | [@backstage/plugin-techdocs-backend][techdocs/backend] | diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 4aadb06aac..727000728f 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -15,8 +15,8 @@ work"](#future-work). With "next" we mean features planned for release within the ongoing quarter from April through June 2022. With "future" we mean features on the radar, but not yet scheduled. -| [What's next](#whats-next) | [Future work](#future-work) | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| [What's next](#whats-next) | [Future work](#future-work) | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | [Ease of onboarding](#ease-of-onboarding)
[Backstage Search 1.0](#search-1.0)
[TechDocs Addon Framework](#techdocs-addon-framework)
[Backend Services (initial)](#backend-services-initial)
[Backstage Security Audit](#backstage-security-audit)
[SIGs for contributors](#sigs-for-contributors) | Security Plan (and Strategy)
Composable Homepage 1.0
GraphQL
Telemetry
Improved UX design | The long-term roadmap (12 - 36 months) is not detailed in the public roadmap.