技术文档

What is it?

TechDocs 是 Spotify 在 Backstage 中直接内置的自制类代码文档解决方案。工程师在 Markdown 文件中编写文档，这些文件与他们的代码放在一起，只需稍加配置，就能在 Backstage 中获得一个漂亮的文档网站。

如今，它已成为 Spotify 开发人员体验服务的核心产品之一，拥有 5000 多个文档站点和大约 10000 次日均点击。在 TechDocs 中了解更多关于它的信息公告博文. 🎉

功能

无论您的软件环境如何设置，都可以部署 TechDocs。 * 从 Backstage Catalog 中的服务页面发现服务的技术文档。 * 只需编写 Markdown 即可创建任何用途的纯文档网站。 * 利用 TechDocs 附加组件框架在基本的类文档代码体验基础上添加功能。 * 探索并利用庞大的 MkDocs 插件生态系统，创建丰富的阅读体验。 * 搜索并查找文档。

项目路线图

现在

目前没有计划。

某天/也许

在 TechDocs 中，我们可以做些什么来帮助提高文档质量？我们有很多想法，例如，带有相关信任分值的信任卡和自动触发文档维护通知。 * 为 TechDocs 附加组件市场做出贡献并从该市场进行部署 * 附加组件：MDX(允许您在 Markdown 内容中使用 JSX) * 我们可以不依赖静态网站生成器吗？ * 与 Scaffolder V2更好地集成(例如，使用软件模板轻松选择和应用文档模板) * 可以配置 TechDocs 的多个方面(例如，URL、主页、主题)。

完成

参见已完成下面是已完成的路线图项目清单。

支持

以下部分显示了 TechDocs 目前支持的源代码托管提供商和文件存储提供商。

参见技术文档架构以了解以下提供商的使用情况。

源代码托管服务提供商

| 源代码托管服务提供商 | 支持状态 | | ---------------------------- | -------------- | GitHub | 是 ✅ | GitHub 企业版 | 是 ✅ | Bitbucket | 是 ✅ | Azure DevOps | 是 ✅ | Gerrit | 是 ✅ | GitLab | 是 ✅ | GitLab 企业版 | 是 ✅ | Gitea | 是 ✅ | GitLab 企业版

文件存储提供商

| 文件存储提供商 | 支持状态 | | --------------------------------- | -------------- | Backstage 应用程序的本地文件系统 | 是 ✅ | Google Cloud Storage (GCS) | 是 ✅ | Amazon Web Services (AWS) S3 | 是 ✅ | Azure Blob Storage | 是 ✅ | OpenStack Swift | Community ✅ | Backstage | 是

联系我们如果您想申请更多的提供商。

技术栈

参与

联系我们**#docs-like-code**我们的Discord 聊天室.

Done

** 阿尔法版本**

里程碑

您可以从头到尾使用技术文档阿尔法，并为其做出贡献。

试用版

里程碑

TechDocs 的推荐设置支持大多数环境(CI 系统、云存储解决方案、源代码控制系统)。 * 从 Alpha 升级到 Beta 的说明

v1.0

TechDocs 升级到了 v1.0！要了解这一变更对软件包的影响，请查看我们的版本管理政策.

TechDocs 软件包：

@backstage/plugin-techdocs * @backstage/plugin-techdocs 后端 * @backstage/plugin-techdocs-node * @techdocs/cli

技术文档附加框架

随着Backstage 1.2 版本的发布，我们引入了TechDocs 附加框架用于增强阅读时的 TechDocs 体验。

除了框架本身，我们还开源了一个报告问题插件，帮助您创建一个反馈回路，以提高文档质量，并在您的组织中培养文档文化。

What is it?​

功能​

项目路线图​

现在​

下一页​

某天/也许​

完成​

支持​

源代码托管服务提供商​

文件存储提供商​

技术栈​

参与​

Done​