Merge pull request #11593 from backstage/roadmap-updates
roadmap-updates
This commit is contained in:
Gary Niemen
@@ -21,14 +21,44 @@ Today, it is one of the core products in Spotify’s developer experience offeri
|
||||
- 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.
|
||||
- Create documentation-only sites for any purpose by just writing Markdown.
|
||||
- Take advantage of the [TechDocs Addon Framework](addons.md) to add features on top of the base docs-like-code experience.
|
||||
- Explore and take advantage of the large ecosystem of
|
||||
[MkDocs plugins](https://www.mkdocs.org/user-guide/plugins/) to create a rich reading experience.
|
||||
- Search for and find docs.
|
||||
|
||||
## Platforms supported
|
||||
## Project roadmap
|
||||
|
||||
See [TechDocs Architecture](architecture.md) to get an overview of where these
|
||||
providers are used.
|
||||
### 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.
|
||||
|
||||
### 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.
|
||||
|
||||
### Someday/Maybe
|
||||
|
||||
- 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?
|
||||
- Better integration with
|
||||
[Scaffolder V2](https://github.com/backstage/backstage/issues/2771) (e.g. easy to choose and apply documentation template with Software Templates)
|
||||
- Possible to configure several aspects about TechDocs (e.g. URL, homepage,
|
||||
theme)
|
||||
|
||||
### Done
|
||||
|
||||
See [Done](#done) below for a list of completed roadmap items.
|
||||
|
||||
## Supported
|
||||
|
||||
The following sections show the source code hosting providers and file storage providers that are currently supported by TechDocs.
|
||||
|
||||
See [TechDocs Architecture](architecture.md) to get an overview of where the below providers are used.
|
||||
|
||||
### Source code hosting providers
|
||||
|
||||
| Source Code Hosting Provider | Support Status |
|
||||
| ---------------------------- | -------------- |
|
||||
@@ -39,6 +69,8 @@ providers are used.
|
||||
| GitLab | Yes ✅ |
|
||||
| GitLab Enterprise | Yes ✅ |
|
||||
|
||||
### File storage providers
|
||||
|
||||
| File Storage Provider | Support Status |
|
||||
| --------------------------------- | -------------- |
|
||||
| Local Filesystem of Backstage app | Yes ✅ |
|
||||
@@ -47,64 +79,17 @@ providers are used.
|
||||
| Azure Blob Storage | Yes ✅ |
|
||||
| OpenStack Swift | Community ✅ |
|
||||
|
||||
[Reach out to us](#feedback) if you want to request more platforms.
|
||||
|
||||
## Project roadmap
|
||||
|
||||
### **Published versions**
|
||||
|
||||
**Alpha release** ✅ -
|
||||
[Milestone](https://github.com/backstage/backstage/milestone/16)
|
||||
|
||||
- Alpha of TechDocs that you can use end to end - and contribute to.
|
||||
|
||||
**Beta release** ✅ -
|
||||
[Milestone](https://github.com/backstage/backstage/milestone/29)
|
||||
|
||||
- TechDocs' recommended setup supports most environments (CI systems, cloud
|
||||
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'
|
||||
|
||||
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).
|
||||
|
||||
**v1.2** 🚧
|
||||
|
||||
With the Backstage 1.2 release, we plan to introduce the [TechDocs Addon Framework](https://github.com/backstage/backstage/issues/9636) for augmenting the TechDocs experience at read-time.
|
||||
|
||||
In addition to the framework itself, we'll be open sourcing a `<ReportIssue />` addon, helping you to create a feedback loop that drives up documentation quality and fosters a documentation culture at your organization.
|
||||
|
||||
### **Next**
|
||||
|
||||
- What can we do in TechDocs to drive up documentation quality?
|
||||
|
||||
### **Someday/Maybe**
|
||||
|
||||
- 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?
|
||||
- Better integration with
|
||||
[Scaffolder V2](https://github.com/backstage/backstage/issues/2771) (e.g. easy to choose and apply documentation template with Software Templates)
|
||||
- Possible to configure several aspects about TechDocs (e.g. URL, homepage,
|
||||
theme)
|
||||
[Reach out to us](#get-involved) if you want to request more providers.
|
||||
|
||||
## Tech stack
|
||||
|
||||
| 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] |
|
||||
| CLI (for local development and generating docs) | [`@techdocs/cli`][techdocs/cli] |
|
||||
| Docker Container (for generating docs) | [`techdocs-container`][techdocs/container] |
|
||||
| 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] |
|
||||
| CLI (for local development and generating docs) | [@techdocs/cli][techdocs/cli] |
|
||||
| Docker Container (for generating docs) | [techdocs-container][techdocs/container] |
|
||||
|
||||
[techdocs/frontend]: https://github.com/backstage/backstage/blob/master/plugins/techdocs
|
||||
[techdocs/frontend-library]: https://github.com/backstage/backstage/blob/master/plugins/techdocs-react
|
||||
@@ -112,7 +97,34 @@ In addition to the framework itself, we'll be open sourcing a `<ReportIssue />`
|
||||
[techdocs/container]: https://github.com/backstage/techdocs-container
|
||||
[techdocs/cli]: https://github.com/backstage/techdocs-cli
|
||||
|
||||
## Contact us
|
||||
## Get involved
|
||||
|
||||
Reach out to us in the `#docs-like-code` channel of our
|
||||
Reach out to us in the **#docs-like-code** channel of our
|
||||
[Discord chatroom](https://github.com/backstage/backstage#community).
|
||||
|
||||
## Done
|
||||
|
||||
**Alpha release**
|
||||
|
||||
[Milestone](https://github.com/backstage/backstage/milestone/16)
|
||||
|
||||
- Alpha of TechDocs that you can use end to end - and contribute to.
|
||||
|
||||
**Beta release**
|
||||
|
||||
[Milestone](https://github.com/backstage/backstage/milestone/29)
|
||||
|
||||
- TechDocs' recommended setup supports most environments (CI systems, cloud
|
||||
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.0**
|
||||
|
||||
TechDocs promoted to v1.0! To understand how this change affects the package, check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
|
||||
|
||||
TechDocs packages:
|
||||
|
||||
- @backstage/plugin-techdocs
|
||||
- @backstage/plugin-techdocs-backend
|
||||
- @backstage/plugin-techdocs-node
|
||||
- @techdocs/cli
|
||||
|
||||
Reference in New Issue
Block a user