Aller au contenu principal

Migration de DocSearch

· 3 minutes de lecture
Clément Vannicatte
Sébastien Lorber

DocSearch migre vers un nouveau système plus puissant, qui donne aux utilisateurs leur propre application Algolia et de nouveaux identifiants.

Les propriétaires de sites Docusaurus doivent mettre à jour leur configuration avec leurs nouvelles informations d'identification avant le 1er février 2022, les index de recherche existants seront figés et deviendront en lecture seule après cette date.

Mise à jour de votre site Docusaurus

Dans les prochaines semaines, les propriétaires de sites Docusaurus recevront un courriel les invitant à rejoindre leur application personnelle Algolia.

Cet e-mail inclura de nouveaux appId et apiKey à utiliser dans votre configuration de Docusaurus.

Les seules choses que vous avez à faire :

  • Rejoignez l'application Algolia (éventuellement en créant un nouveau compte Algolia)
  • Mettez à jour la configuration de votre site.
docusaurus.config.js
const config = {
themeConfig: {
algolia: {
appId: '<NEW_APP_ID>',
apiKey: '<NEW_SEARCH_API_KEY>',
},
},
};

module.exports = config;
info

appId est maintenant obligatoire.

Ces clés ne sont pas des secrets et peuvent être ajoutées à votre dépôt Git.

DocSearch a une nouvelle maison !

Qu'est-ce que DocSearch ?

DocSearch est un programme créé par Algolia, qui propose la recherche dans la documentation technique des projets Open Source et des blogs techniques gratuitement.

Vous pouvez en lire plus ici, et l'appliquer si vous voulez essayer !

De quoi traite cette migration ?

Motivation

Avec la prochaine version stable de DocSearch UI, nous avons voulu aller plus loin et fournir un meilleur outillage à nos utilisateurs pour améliorer leur recherche, mais aussi exploiter tout le potentiel d'Algolia.

Quoi de neuf ?

DocSearch exploite désormais le Algolia Crawler, qui comprend une interface web qui vous permettra de :

  • Lancer, planifier et surveiller vos recherches de contenu
  • Modifier votre fichier de configuration à partir d'un éditeur en direct
  • Tester vos résultats avec DocSearch v3

Algolia crawler overview

Algolia config editor

Mais aussi, plus de fonctionnalités Algolia dans votre propre application Algolia :

  • Gestion d'équipe
  • Explorer et voir comment vos documents sont indexés dans Algolia
  • Essayez d'autres fonctionnalités d'Algolia avec des évaluations gratuites

Algolia index overview

Algolia index analytics

Et bien sûr, beaucoup plus, gratuitement.

FAQ

J'utilise Docusaurus et DocSearch, puis-je migrer ?

Au moment où nous écrivons ceci, nous sommes encore à un stade précoce de la migration. Nous faisons de petits lots chaque semaine mais nous allons augmenter la charge sous peu, alors soyez patient et gardez un œil sur votre boîte aux lettres, vous serez contacté dès que votre application Algolia sera prête !

Où puis-je en savoir plus à ce sujet ?

Nous avons écrit un petit guide de migration mais vous aurez des informations plus détaillées dans l'email de migration.

J'ai reçu l'email de migration mais l'invitation a expiré

Veuillez nous contacter par email ou par Discord DocSearch ou sur le canal Discord Docusaurus #algolia

J'ai un retour d'expérience !

Pour tout commentaire concernant notre documentation ou le composant de l'interface utilisateur DocSearch, vous pouvez ouvrir un ticket sur notre dépôt GitHub, mais aussi nous contacter via les méthodes ci-dessus.

Puis-je quand même exécuter ma propre instance DocSearch ?

En faveur de la nouvelle infrastructure et de DocSearch v3, nous ne maintiendrons plus nos chers DocSearch scraper et DocSearch v2, mais les dépôts seront toujours disponibles et ouverts aux pull requests.

La documentation précédente (désormais appelée legacy) reste disponible ainsi que notre guide run your own.