本文へ移動

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アプリケーションへの参加を促すメールを受け取ります。

このメールには、Docusaurus設定で使用するための新しいappIdとapiKeyが含まれています。

必要な作業

  • 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.

もちろん、無料で、さらに多くの機能を提供します。

FAQ​

DocusaurusとDocSearchを使用していますが、移行できますか？​

執筆時点では、移行はまだ初期段階です。毎週少量ずつ行っていますが、すぐに負荷を増やす予定ですので、お待ちいただき、メールボックスをご確認ください。Algoliaアプリの準備が整い次第、ご連絡いたします！

詳細はこちら​

簡単な移行ガイドを作成しましたが、移行メールでより詳細な情報をご覧いただけます。

移行メールを受け取りましたが、招待が期限切れになりました​

メールまたはDocSearchのDiscord、あるいはDocusaurusのDiscord #algoliaチャンネルでお問い合わせください。

フィードバックがあります！​

ドキュメントまたはDocSearch UIコンポーネントに関するフィードバックについては、GitHubリポジトリで問題を報告するか、上記の方法でお問い合わせください。

独自のDocSearchインスタンスを実行できますか？​

新しいインフラストラクチャとDocSearch v3を優先するため、人気のDocSearchスクレイパーとDocSearch v2はメンテナンスしなくなりますが、リポジトリは引き続き利用可能であり、プルリクエストを受け付けます。

以前のドキュメント（現在は「レガシー」と呼ばれています）と「独自の実行」ガイドは引き続き利用可能です。