跳到主要内容

DocSearch 迁移

·4分钟阅读
Clément Vannicatte
Clément Vannicatte
软件工程师 @ Algolia
Sébastien Lorber
Sébastien Lorber
Docusaurus 维护者，《本周 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，它包含一个网页界面，可以让你进行以下操作：

  • 启动、安排和监控你的抓取任务
  • 通过实时编辑器编辑你的配置文件
  • 使用 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 scraper 和 DocSearch v2，但这些仓库仍将可用并接受拉取请求。

之前的文档（现在称为 `legacy`）仍然可用，以及我们的 `run your own` 指南。