跳到主要内容

DocSearch 迁移

· 阅读需 4 分钟
Clément Vannicatte
Clément Vannicatte
软件工程师@ Algolia
Sébastien Lorber
Sébastien Lorber
Docusaurus maintainer, This Week In React editor

DocSearch is migrating to a new, more powerful system, which gives users their own Algolia application and new credentials.

Docusaurus site owners should upgrade their configuration with their new credentials by February 1, 2022, existing search indexes will be frozen and become read-only after this date.

升级你的 Docusaurus 网站​

在接下来的几周，Docusaurus 网站所有者将收到一封电子邮件，邀请您加入 Algolia 个人应用。

This email will include a new appId and apiKey to use in your Docusaurus configuration.

您只需要：

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

module.exports = config;
信息

appId is now required.

这些密钥不是机密，可以添加到您的 Git 仓库中。

Docsearch 有一个新家了！​

DocSearch 是什么？​

DocSearch is a program created by Algolia, which offers search to technical documentation of Open Source projects and technical blogs for free.

You can read more here, and apply if you'd like to give it a try!

What is this migration about?​

动机​

With the upcoming stable release of DocSearch UI, we wanted to go further and provide better tooling for our users to improve their search, but also leverage the full potential of Algolia.

What's new?​

DocSearch now leverages the Algolia Crawler, which includes a web interface that will allow you to:

  • 启动，规划和监视你的 crawl
  • 使用在线编辑器编辑您的配置文件
  • 借助于 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.

But also, more Algolia features in your own Algolia app:

  • 团队管理
  • 浏览并查看您的记录是如何在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.

And of course, a lot more, for free.

FAQ​

I'm using Docusaurus and DocSearch, can I migrate?​

At the time we are writing this, we are still at an early stage of the migration. We are doing small batches every week but will increase the load shortly, so please be patient and keep an eye out in your mailbox, you'll be contacted as soon as your Algolia app is ready!

Where can I read more about this?​

We wrote a small migration guide but you'll have more detailed information in the migration email.

I received the migration email but the invite expired​

Please contact us via either email or DocSearch's Discord or on Docusaurus's Discord #algolia channel

I have feedback!​

For any feedback regarding our documentation or the DocSearch UI component, you can open an issue on our GitHub repository, but also contact us via the methods above.

Can I still run my own DocSearch instance?​

In favor of the new infrastructure and DocSearch v3, we will no longer maintain our beloved DocSearch scraper and DocSearch v2, but the repositories will still be available and open to pull requests.

The previous documentation (now called legacy) remains available as well as our run your own guide.