paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 29 Packages Projects Releases Wiki Activity

roadmap_updates-techdocs_search

Browse Source 
Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com>
This commit is contained in:
Gary Niemen
2022-08-03 16:53:49 +02:00
committed by blam
parent 84ad48160a
commit 2977f2473d
3 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/search/README.md
+4
View File
@@ -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.
docs/features/techdocs/README.md
+9 -4
View File
@@ -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.