Aller au contenu principal
Version : Ancienne (v1.x - v2.x)

FAQ

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 d'assistance.

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.

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. Vous trouverez plus de détails sur les spécifications techniques ici, et des informations complètes dans notre politique de confidentialité.

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

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

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.

Nous recommandons plutôt d'exclure les blocs de code via l'option selectors_exclude de votre configuration, et de structurer votre contenu pour inclure les noms de méthodes dans les en-têtes.

Pourquoi ai-je du contenu dupliqué dans mes résultats ?​

Cela survient lorsque plusieurs URL pointent vers le même contenu, par exemple ./docs, ./docs/ et ./docs/index.html.

Définissez stop_urls avec les motifs à exclure. Cet exemple exclura les URL terminant par / ou index.html :

{
  "stop_urls": ["/$", "/index.html$"]
}

Pourquoi mes modifications manuelles via le tableau de bord Algolia sont-elles inefficaces ?​

Modifier vos paramètres via le tableau de bord peut sembler utile dans certains cas.

Chaque crawl réussi réinitialise les paramètres DocSearch. Ces paramètres seront écrasés au prochain crawl. Nous déconseillons toute modification via le tableau de bord, car ces réglages proviennent de la configuration JSON.

Utilisez plutôt le paramètre custom_settings pour ce besoin.

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

Nous serions ravis d'aider !

Si la documentation d'un de vos outils préférés n'utilise pas DocSearch, suggérez-leur dans un ticket GitHub comment ce service pourrait les aider. Vous pouvez aussi nous écrire, nous ferons notre possible pour vous accompagner.

Combien d'enregistrements un crawl DocSearch génère-t-il ?​

La propriété nb_hits de votre configuration indique le nombre d'enregistrements extraits et indexés lors du dernier crawl DocSearch. Ce chiffre est mis à jour automatiquement.

Le scraper DocSearch applique la stratégie recommandée de réindexation atomique. Il crée un nouvel index temporaire pour y injecter les données scrapées. Si l'opération réussit, le crawl remplace l'ancien index (défini par index_name dans votre configuration).

Pourquoi certaines pages ne sont-elles pas indexées ?​

Nous scrapons votre site selon votre configuration. Certaines pages peuvent manquer dans les résultats de recherche. Voici quelques explications possibles :

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

Ce site est développé avec Docusaurus v2. Nous avons été aidés par une personne exceptionnelle qui nous a profondément inspirés : Endi. Nous tenons à rendre hommage à cet être humain remarquable qui fera toujours partie du projet DocSearch. Repose en paix, l'ami !

Quel est le calendrier pour la version 3 ?​

Nous proposons actuellement une pré-version v3 pour Docusaurus 2. Cela nous permettra d'itérer plus rapidement et de finaliser une version autonome. Un guide de migration sera fourni pour faciliter la transition. Pour plus d'informations sur cette version, vous pouvez visionner notre "search party" dédiée à ce sujet.

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

La apiKey fournie par l'équipe DocSearch est une clé réservée à la recherche et peut être partagée publiquement sans risque. Vous pouvez la versionner dans votre système de contrôle de code source (comme Git). Si vous exécutez le scraper vous-même, créez une clé réservée à la recherche et ne partagez jamais votre clé Admin.