Aller au contenu principal
Version : Stable (v4.x)

Programme DocSearch

Traduction Bêta Non Officielle

Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →

Si vous ne trouvez pas la réponse à votre question sur ce site, cette page vous aidera. Si vous avez encore des doutes, n'hésitez pas à nous contacter sur Discord ou à en informer notre équipe de support.

Pour les questions concernant DocSearch x Algolia Crawler, consultez notre FAQ Crawler.

Que dois-je installer de mon côté ?​

Vous devez simplement implémenter DocSearch dans votre frontend avec les identifiants reçus par e-mail lors du déploiement de votre application.

DocSearch utilise l'Algolia Crawler, qui propose une interface web pour créer, surveiller, modifier et lancer vos Crawlers. Pour toute question à ce sujet, reportez-vous à notre FAQ Crawler.

Quel est le coût ?​

C'est gratuit !

Nous savons que le coût d'une infrastructure de recherche n'est pas accessible à tous les projets open source. C'est pourquoi nous avons choisi de maintenir DocSearch gratuit pour tous. En échange, nous vous demandons simplement d'afficher le logo "Recherche par Algolia" à côté des résultats.

Si cela vous est impossible, vous pouvez librement ouvrir votre propre compte Algolia et gérer DocSearch vous-même sans cette limitation. Dans ce cas, selon la taille de votre documentation, un compte payant pourra être nécessaire (les comptes gratuits gèrent jusqu'à 10 000 enregistrements).

Quelles données collectez-vous ?​

Nous conservons les données extraites du balisage de votre site, que nous convertissons dans un format JSON personnalisé plutôt qu'en HTML. Ces données alimentent l'index Algolia DocSearch. Les sélecteurs de votre configuration définissent quelles données scraper.

En tant que propriétaire du site, nous vous donnons aussi accès à votre propre application Algolia. Vous pourrez ainsi voir comment votre site est indexé, consulter des analyses détaillées sur les recherches anonymisées, gérer votre équipe, et plus encore !

Où mes données sont-elles hébergées ?​

Nous hébergeons les données DocSearch sur les serveurs d'Algolia, avec des réplications mondiales. Détails techniques sur les spécifications des serveurs, et informations complètes dans notre politique de confidentialité.

Comment mettre à niveau mon application DocSearch ?​

Plusieurs options selon vos besoins !

Mise à niveau #1 : J'aimerais une fonctionnalité spécifique (ex: Règles) dans mon application existante​

Contactez-nous et nous pourrons probablement vous aider !

Mise à niveau #2 : Je souhaite retirer le logo Algolia​

Cela vous exclura du programme gratuit DocSearch. Nous proposons une version héritée open source du Crawler que vous pouvez auto-héberger, ou utilisez nos clients API. Mais vous devrez créer une nouvelle application Algolia et payer son utilisation.

Mise à niveau #3 : Algolia est génial, je veux l'utiliser sur tout mon site​

C'est génial ! Contactez notre équipe commerciale qui pourra vous aider à choisir la formule adaptée. Une fois votre nouvelle application créée, vous pourrez simplement copier-coller votre configuration de Crawler dans le Crawler de votre nouvelle application.

Puis-je utiliser DocSearch sur des pages non documentaires ?​

Le service DocSearch gratuit indexe uniquement les pages de documentation de projets open-source ou les blogs techniques. Pour l'utiliser sur d'autres parties de votre site, vous devrez créer votre propre compte Algolia et soit :

Pouvez-vous indexer des exemples de code ?​

Oui, mais nous ne le recommandons pas.

Les exemples de code sont utiles pour comprendre l'usage d'une méthode, mais leur code récurrent et les répétitions ajoutent du bruit dans les résultats.

Un site de documentation que j'apprécie n'utilise pas DocSearch. Que puis-je faire ?​

Nous serions ravis d'aider !

Si la documentation de l'un de vos outils préférés manque de DocSearch, nous vous encourageons à ouvrir une issue dans leur dépôt pour expliquer les bénéfices de DocSearch. N'hésitez pas aussi à nous en parler sur Discord et nous apporterons toute l'aide possible.

Comment ce site web a-t-il été construit ?​

Nous avons développé ce site avec Docusaurus v2. Nous avons été inspirés par Endi, une personne exceptionnelle. Nous tenons à rendre hommage à cet être humain remarquable qui restera toujours associé au projet DocSearch. Repose en paix camarade !

Puis-je partager la clé apiKey dans mon dépôt ?​

La clé apiKey fournie par l'équipe DocSearch est une clé search-only et peut être partagée publiquement en toute sécurité. Vous pouvez la versionner dans votre système de contrôle (ex: git). Si vous exécutez vous-même le scraper, assurez-vous de créer une clé search-only et ne partagez jamais votre clé Admin.

Pourquoi la clé API dans l'email diffère-t-elle de celle du dashboard ?​

Chaque application Algolia possède une "clé API de recherche" par défaut visible dans le dashboard. Cette clé permet de lister les indices, leurs paramètres et d'effectuer des recherches sur tous les indices de votre application. Dans le cadre de DocSearch, l'email de confirmation contient une clé API UNIQUEMENT dédiée à la recherche et limitée à votre index DocSearch. Si vous avez besoin de récupérer cette clé, contactez notre équipe de support.

Comment renouveler mes clés API ?​

Contactez notre équipe de support.

Puis-je avoir plusieurs projets dans la même application Algolia ?​

Nous recommandons d'utiliser une seule application Algolia par projet. Faites une demande si vous souhaitez utiliser DocSearch pour un autre de vos projets.

Pourquoi ?​

Les informations du projet initial sont utilisées partout lors du déploiement :

  • La portée de vos clés API

  • Le nom de votre application/Crawler Algolia

  • Les indices générés

  • Les domaines autorisés pour votre Crawler

Cela nous permet de cibler facilement les problèmes lorsque vous contactez le support.

Assistance​

prudence

Assurez-vous de consulter la documentation avant de nous contacter.

Voici quelques liens utiles :

Vous pouvez également consulter l'académie Algolia pour mieux comprendre Algolia.

Veuillez noter qu'Algolia ne fournit pas de support pour DocSearch lui-même, mais nous pouvons prendre en charge les demandes concernant les produits suivants :

Pour tout problème lié à la bibliothèque d'interface DocSearch, veuillez ouvrir une issue GitHub.