Hébergement de Document360 dans un sous-dossier

Qu’est-ce que l’hébergement de sous-dossiers?

L’hébergement en sous-dossiers est la méthode d’organisation et d’affichage du contenu sur un site web à l’aide de dossiers relevant du domaine principal (racine). Un sous-dossier (également appelé sous-répertoire) apparaît après le domaine racine dans une URL et est utilisé pour structurer le contenu de manière logique.
Par exemple, le domaine racine de Document360 est document360.com. Ainsi, une URL de chemin de sous-dossier ou sous-répertoire pourrait être document360.com/docs/.

La plupart des entreprises hébergent leur documentation sous un sous-dossier ou sous-répertoire sur leur domaine web.
Par exemple : example.com/docs, example.com/support, etc.

Cela s’explique par le fait que l’hébergement d’une base de connaissances sur un sous-répertoire/sous-dossier d’un site web (example.com/docs) plutôt que sur un sous-domaine (docs.example.com) est préférable pour l’optimisation moteur de recherche (SEO).

NOTE

L’hébergement de sous-dossiers/sous-répertoires peut être activé pour les domaines fournis par Document360 et les domaines personnalisés mappés.

Activation de l’hébergement de sous-dossiers

Pour permettre l’hébergement du sous-dossier de votre projet,

1. Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du Knowledge base portal.

2. Dans le panneau de navigation de gauche, naviguez vers Custom domain personnalisé > Subfolder hosting .

   Par défaut, le chemin du sous-dossier est défini sur /docs.

3. Activez la fonction basculante à côté de « La base de connaissances est hébergée comme sous-dossier ».
   Lorsque le bouton est activé, l’aperçu public des articles sera visible. Cela empêche également l’insertion du slug de l’espace de travail lors de l’insertion de liens dans les articles.

Chemins de sous-dossiers personnalisés

Vous pouvez aussi configurer votre base de connaissances sur des chemins de sous-dossiers/sous-répertoires autres que /docs.

Par exemple, /help, /support, etc.

1. Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du Knowledge base portal.

2. Dans le panneau de navigation de gauche, naviguez vers Custom domain personnalisé > Subfolder hosting .

   Par défaut, le chemin du sous-dossier est défini sur /docs.

3. Effacez le champ de chemin du sous-dossier et entrez le chemin de votre sous-dossier personnalisé (par exemple, /help).

4. Cliquez sur le Update jour à droite.

   Ce nouveau sous-dossier personnalisé ne fonctionnera que si le paramètre d’hébergement du sous-dossier est activé dans votre projet.

Lorsque vous configurez d’autres chemins, ajoutez les langages associés à chaque espace de travail dans votre projet. Cette configuration varie selon les différents serveurs web.

NOTE

Pour les projets configurés avec un hébergement personnalisé de domaine et de sous-dossiers, l’option d’aperçu de l’article n’est pas encore prise en charge.

Si vous avez défini un chemin de sous-dossier personnalisé, n’oubliez pas de configurer votre serveur pour qu’il fasse des requêtes proxy pour ce chemin. Vous pouvez consulter les articles spécifiques aux serveurs de la plateforme pour obtenir des conseils.

Chemins personnalisés de l’API du site

Pour votre information (pour info)

La fonctionnalité de chemins d’API personnalisés pour les sites est disponible uniquement dans les projets KB Site 2.0. Pour migrer du site KB 1.0 vers le site KB 2.0, lisez l’article sur la migration du site KB 2.0.

Par défaut, le chemin de l’API du site est défini sur /api. Vous pouvez également personnaliser le chemin de l’API Site depuis l’onglet Hébergement des sous-dossiers dans les paramètres de domaine personnalisé.

Par exemple, /docs-api, /api-docs, etc.

Après avoir défini le chemin de l’API du site, vous devez également configurer un bloc de localisation correspondant sur votre serveur web (comme /api, /docs-api, etc.).

Assurez-vous que la valeur saisie ici correspond exactement au chemin configuré dans la configuration du reverse proxy de votre serveur.

Consultez le guide serveur pertinent pour des exemples de configuration :

• Serveur Nginx – Hébergement de sous-dossiers

• ASP.NET Serveur central

• Microsoft – serveur IIS

• Serveur HTTP Apache

ATTENTION

Pour les projets KB Site 2.0 , l’hébergement de sous-dossiers ne fonctionnera que lorsque le chemin des sous-dossiers ainsi que celui de l’API du site ont été définis.

1. Naviguez dans () > Knowledge base site dans la barre de navigation de gauche du Knowledge base portal.

2. Dans le panneau de navigation de gauche, naviguez vers Custom domain > Subfolder hosting

   Par défaut, le chemin de l’API Site est défini sur /api.

3. Effacez le champ de chemin de l’API du site et entrez votre chemin d’API personnalisé (par exemple, /docs-api).

4. Cliquez sur le Update jour à droite.

   Ce nouveau chemin d’API personnalisé ne fonctionnera que si le paramètre d’hébergement des sous-dossiers est activé dans votre projet.

NOTE

Le chemin de l’API du site personnalisé n’est pas celui de la documentation de l’API.

Serveurs web

Voici quelques-uns des serveurs web couramment utilisés

• Serveur HTTP Apache

• Serveur Nginx

• ASP.NET Serveur central

• Microsoft - serveur IIS

• Serveur OpenResty

• Serveur LiteSpeed

• Serveur Cloudflare

NOTE

Qu’est-ce qu’un serveur web ?
Un serveur web stocke et distribue le contenu d’un site web – tel que texte, images, vidéo et données d’application – aux clients qui le demandent. Le type de client le plus courant est un navigateur web.

Mise en place obligatoire du chemin API pour le site KB 2.0

Si vous utilisez KB 2.0 et hébergez votre base de connaissances dans un sous-dossier, il est obligatoire d’ajouter une configuration proxy inverse pour votre chemin de l’API Site (par exemple, /api) dans les paramètres de votre serveur.

Sans cette configuration, vous pouvez rencontrer des erreurs de redirection ou des comportements d’API défaillants.

Consultez l’article pertinent sur le serveur pour les instructions de configuration :

• Serveur Nginx – Hébergement de sous-dossiers

• ASP.NET Serveur central

• Microsoft – serveur IIS

• Serveur HTTP Apache

Que se passe-t-il ensuite ?

Une fois le serveur web configuré avec succès, votre site de base de connaissances sera en ligne sur votre sous-dossier/sous-répertoire personnalisé. Cependant, l’URL existante de votre projet servira les requêtes.
Par exemple, example.document360.io et example.com/docs (si /docs c’est le chemin de votre dossier) pointera vers le site de la base de connaissances.

Cela provoquera des dupliqués de contenu dans les moteurs de recherche (Google, Bing, etc.). Pour cela, vous devrez activer une redirection d’URL.

NOTE

Pour permettre la redirection de example.document360.io vers example.com/docs, veuillez nous contacter à support@document360.com.

Dépannage

L’URL affiche toujours '/docs' malgré la désactivation de l’hébergement des sous-dossiers

Par défaut, la documentation est hébergée dans le /docs sous-dossier, et ce chemin reste visible dans l’URL, que le paramètre d’hébergement du sous-dossier soit activé ou désactivé.

Étapes à résoudre :

Pour changer le chemin,

1. Créez un nouveau sous-dossier dans votre projet.

2. Activez le paramètre d’hébergement du sous-dossier nouvellement créé.

3. Complétez la configuration requise pour appliquer le chemin d’URL personnalisé.

Erreur 404 due à un duplique de '/docs' dans l’URL canonique

Lorsque votre site est hébergé dans un /docs sous-dossier, ajouter /docs l’URL canonique fait apparaître deux fois dans l’URL finale (par exemple, nom d’article/docs/docs/), entraînant une erreur 404.

Étapes à résoudre :

1. Pour résoudre le problème, mettez à jour l’URL canonique pour n’inclure que le domaine sans le /docs chemin. Par exemple, définissez l’URL canonique comme suit : https://yourdomain.com/article-name

2. Cela garantit que le /docs sous-dossier n’est ajouté qu’une seule fois, en maintenant la bonne structure d’URL et en évitant les erreurs 404.