跳至主要内容

DocSearch 迁移

·阅读时长 3 分钟
Clément Vannicatte
Clément Vannicatte
Algolia 软件工程师
Sébastien Lorber
Sébastien Lorber
Docusaurus 维护者，This Week In React 编辑

DocSearch 正在迁移到一个新的、功能更强大的系统，该系统为用户提供了他们自己的 Algolia 应用程序和新的凭据。

Docusaurus 站点所有者应使用其新的凭据在 2022 年 2 月 1 日之前升级其配置，在此日期之后，现有的搜索索引将被冻结并变为只读。

升级您的 Docusaurus 站点​

在接下来的几周内，Docusaurus 站点所有者将收到一封电子邮件，邀请他们加入其个人 Algolia 应用程序。

此电子邮件将包含新的appId 和apiKey，供您在 Docusaurus 配置中使用。

您需要做的

  • 加入 Algolia 应用程序（可能需要创建一个新的 Algolia 帐户）
  • 更新您的站点配置。
docusaurus.config.js
const config = {
  themeConfig: {
    algolia: {
      appId: '<NEW_APP_ID>',
      apiKey: '<NEW_SEARCH_API_KEY>',
    },
  },
};

module.exports = config;
信息

appId 现在是必需的。

这些密钥不是秘密，可以添加到您的 Git 存储库中。

DocSearch 有了新家！​

什么是 DocSearch？​

DocSearch 是由 Algolia 创建的一个程序，它免费为开源项目的技术文档和技术博客提供搜索功能。

您可以在 此处阅读更多信息，并 申请 以便试用！

此次迁移的目的是什么？​

动机​

随着 DocSearch UI即将发布稳定版本，我们希望更进一步，为用户提供更好的工具来改进他们的搜索，同时利用 Algolia 的全部潜力。

有什么新变化？​

DocSearch 现在利用了 Algolia Crawler，其中包含一个 Web 界面，允许您

  • 启动、计划和监控您的爬取
  • 从实时编辑器编辑您的配置文件
  • 使用 DocSearch v3 测试您的结果

The Algolia crawler front page showing the project&#39;s overview, such as last complete crawl and indices

The Algolia config editor opened to the docusaurus-2 config. The right pane shows the results for index and various facet filters.

此外，您还可以使用您自己的 Algolia 应用程序享受更多 Algolia 功能

  • 团队管理
  • 浏览并查看您的记录如何在 Algolia 中建立索引
  • 使用免费试用版尝试其他 Algolia 功能

The Algolia index overview page, showing various filters and the details of every single index

The Algolia index analytics page, showing trends for total users, total searches, etc.

当然，还有更多免费功能。

常见问题​

我正在使用 Docusaurus 和 DocSearch，可以迁移吗？​

在我们撰写本文时，迁移仍处于早期阶段。我们每周都在进行小批量的迁移，但很快就会增加负载，因此请耐心等待并留意您的邮箱，您的 Algolia 应用程序准备就绪后，我们会立即与您联系！

在哪里可以阅读更多相关信息？​

我们编写了一个简短的 迁移指南，但您将在迁移电子邮件中获得更详细的信息。

我收到了迁移电子邮件，但邀请已过期​

请通过 电子邮件 或 DocSearch 的 Discord 或 Docusaurus 的 Discord #algolia 频道 与我们联系

我有反馈！​

对于有关我们的文档或 DocSearch UI 组件的任何反馈，您可以在 我们的 GitHub 存储库中打开问题，也可以通过上述方式与我们联系。

我是否仍然可以运行我自己的 DocSearch 实例？​

为了支持新的基础设施和 DocSearch v3，我们将不再维护我们心爱的 DocSearch 爬虫 和 DocSearch v2，但这些存储库仍然可用并开放拉取请求。

以前的文档（现在称为legacy）以及我们的 自行运行 指南仍然可用。