Règle de redirection d’article

Plans prenant en charge cette fonctionnalité : Professional Business Enterprise

Vous pouvez configurer une règle de redirection d'article pour n'importe quelle URL d'article publiée ou brouillon. La fonction de redirection est utile lorsque vous modifiez l'URL d'un article et que cette même URL a été référencée dans d'autres articles sur votre site de base de connaissances. Vous pouvez aussi effectuer une importation massive des règles de redirection.

Les règles de redirection empêchent les utilisateurs de cliquer sur des liens morts ou cassés.

Ajout d'une règle de redirection d'article

Vous pouvez modifier l'URL ou le slug d'un article avant ou après la publication de la page de l'article ou de la catégorie. L'URL d'une catégorie de type index peut également être modifiée. Vous pouvez effectuer ces modifications directement dans l'éditeur d'articles.

Pour ajouter la règle de redirection de l'article, suivez les étapes ci-dessous :

Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers Article redirect rules.
La page des règles de redirection d'article apparaîtra avec une liste des règles existantes (le cas échéant).
Cliquez sur Nouvelle redirection pour créer une nouvelle règle de redirection.
Le nouveau panneau de règles de redirection apparaîtra.
Sélectionnez le type de Redirection souhaité :
a. Se termine par : Définir la règle de redirection pour un article avec le slug unique à la fin de votre URL.
b. Remplacer par : Définir la règle de redirection pour le texte URL entre le nom de domaine et le slug de l'article.
NOTE
Dans le champ de règle de Redirection , les personnages spéciaux suivants sont pris en charge : # % ^ & _ - + = | . ? /

Overview of article redirect rules in a knowledge base management system interface.

Finit par

Dans le champ Chemin source , tapez le slug unique à la fin de votre URL pour la redirection.

NOTE
Le slug URL dans le chemin source doit commencer par une barre oblique (/).

Dans le champ URL de destination , tapez l'URL de destination complète ou tapez le nouveau slug pour redirection. Ajouter une barre oblique (/) au début de l'URL de destination est optionnel.

Exemple : Pour rediriger l'URL de l'article de https://docs.document360.com/docs/getting-started-with-document360 vers https://docs.document360.com/docs/getting-started-video-library, ajoutez le chemin source et l'URL de destination comme mentionné ci-dessous :
Chemin source : /getting-started-with-document360
URL de destination : getting-started-video-library

Cliquez sur Créer.

Remplacez par

Dans le champ Chemin source , tapez le texte entre le domaine et le slug de l'article que vous souhaitez rediriger.

Exemple : Le chemin source dans l'URL https://project.technicaldocumentation.com/v1/docs/fr/getting-started est /v1/docs/fr/.

NOTE
Le chemin source doit commencer et se terminer par une barre oblique avant (/).

Dans le champ Remplacer le texte , tapez le texte de la nouvelle URL que vous souhaitez utiliser pour la redirection.

Exemple : Remplacez /v1/docs/fr/ par /v2/docs/en/ dans l'URL https://project.technicaldocumentation.com/v1/docs/fr/getting-started.

NOTE
Le texte de remplacement doit commencer et se terminer par une barre oblique avant (/).

Cliquez sur Créer.

Meilleures pratiques

Si vous gérez une base de connaissances multilingue avec plusieurs espaces de travail de projet, définissez des règles de redirection basées sur la langue ou l'espace de travail. Par exemple, si vous définissez une règle avec le chemin /customer-support source et la destination /sales-and-support, cela ne s'applique qu'au langage par défaut de l'espace de travail principal.

Pour appliquer cette règle à une autre langue (par exemple, allemand : /de/), créez une nouvelle règle avec le chemin /de/customer-support source et la destination /de/sales-and-support.
Pour appliquer la règle dans un autre espace de travail (par exemple, version 1 : /v1/), fixez le chemin /v1/docs/customer-support source et la destination /v1/docs/sales-and-support.

Règle de redirection au niveau du site

Dans la page des règles de redirection de l'article , vous pouvez définir une règle de redirection en sous-dossier au niveau du site en utilisant l'option Remplacer par . C'est utile pour migrer depuis une autre plateforme ou rediriger des espaces de travail/langues supprimés ou cachés.

Exemple : Définissez une règle de redirection pour le sous-dossier /azure/serverless dans /data/cloud360 les URLs comme https://apidocs.serverless360.com/azure/serverless/article_slug.

Modification d'une règle de redirection

Pour modifier la règle de redirection de l'article, suivez les étapes ci-dessous :

Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers Article redirect rules.
La page des règles de redirection d'article apparaîtra avec une liste des règles existantes (le cas échéant).
Utilisez le Filtre pour trouver la règle de redirection souhaitée.
Survolez la règle souhaitée et cliquez sur l' icône Modifier ().
Le panneau de règles de redirection d'édition apparaîtra.
Mettez à jour le(s) champ(s) nécessaire(s).
Cliquez sur Mettre à jour.

Suppression d'une règle de redirection

Pour supprimer une règle de redirection d'article, suivez les étapes suivantes :

Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers Article redirect rules.
La page des règles de redirection d'article apparaîtra avec une liste des règles existantes (le cas échéant).
Utilisez Filtre pour trouver la règle de redirection souhaitée.
Survolez la règle souhaitée et cliquez sur l' icône Supprimer ().
Pour supprimer plusieurs règles, sélectionnez les cases à cocher à côté des règles et cliquez sur Supprimer.
Cliquez sur Oui dans le panneau de confirmation Supprimer .

NOTE
Les règles de redirection supprimées ne peuvent pas être récupérées.

Filtrer une règle de redirection

Pour filtrer la règle de redirection souhaitée, suivez les étapes ci-dessous :

Recherche : Saisissez un mot-clé depuis le chemin source ou l'URL de destination dans la barre de recherche, et le résultat est rempli.
Type : Filtrer par le type de redirection : Terminer par, Remplacer par, ou Les deux.
Date de modification : Filtrez les règles par la dernière date de modification, avec des options telles que 1 an, 3 mois, 30 jours ou 7 jours. Cliquez sur Date personnalisée pour choisir n'importe quelle plage de dates personnalisée et sélectionnez la plage de dates souhaitée.

Importation des règles de redirection

Pour importer immédiatement les règles de redirection en masse, téléchargez un CSV correspondant au modèle suivant :

Source	Destination	RedirectionType
`/myoldarticle`	`newarticle`	fin avec
`/en/customers/`	`/v1/docs/`	remplacer avec

NOTE
La taille du fichier doit être inférieure ou égale à 1 Mo.

Modèle de fichier de règle d'importation de redirection

Vous pouvez également télécharger le modèle ici :

import-redirect-rule.csv

Pour importer des règles de redirection en masse :

Préparez un fichier CSV correspondant au modèle fourni (taille du fichier ≤ 1 Mo).
Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers Article redirect rules.
Cliquez sur la règle d'importation et de redirection.
Le panneau de règles de redirection d'importation apparaîtra.
Glisser-déposer le fichier CSV ou sélectionner Cliquer pour téléverser.
Consultez la liste des règles valides et invalides.
NOTE
Cliquez sur l' icône Télécharger () près du compte des règles invalides pour télécharger la liste des règles invalides.
Cliquez sur Importer pour appliquer les règles valides.

Règles de redirection d'exportation

Pour exporter les règles de redirection en fichier CSV, suivez les étapes ci-dessous :

Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers Article redirect rules.
Cliquez sur Exporter pour télécharger les règles en fichier CSV.

Dépannage

Article publié redirigeant ou affichant une erreur 404

Un article publié sur le site de la base de connaissances peut rediriger vers un autre article ou entraîner une erreur 404 en raison d'une règle de redirection mal configurée appliquée au lien de l'article.

Étapes à résoudre :

Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers Article redirect rules.
Utilisez la barre de recherche pour trouver le slug de l'article et vérifier si une règle de redirection est appliquée.
Si une règle de redirection est appliquée, examinez son objectif. Si la règle est inutile ou mal configurée, supprimez-la.
Enregistrez les modifications et relisez l'article pour vous assurer qu'il s'affiche comme prévu sur le site de la base de connaissances.

Si le problème persiste après avoir suivi ces étapes, veuillez contacter l’équipe d’assistance Document360 pour obtenir de l’aide supplémentaire : Contacter l’assistance Document360

Rencontrer une erreur lors de la sauvegarde d'une règle de redirection d'article.

Erreur : Règle de redirection de l'article échouée. La source donnée fait déjà partie d'une destination existante.

Cette erreur survient lorsqu'un slug de destination (la cible d'une règle de redirection existante) est utilisé comme chemin source pour une autre redirection. Une fois qu'une destination est définie dans une règle de redirection, elle devient une cible statique et ne peut plus être réutilisée comme source dans une nouvelle règle.

Étapes à résoudre :

Assurez-vous que le slug de destination n'est pas utilisé comme chemin source dans les règles de redirection existantes ou nouvelles.
Révisez et mettez à jour vos règles de redirection pour éviter les conflits.

An error message indicating failure to save article redirection rule in the Knowledge base portal.

Éviter les erreurs 404 après avoir supprimé des langages dans le site de la base de connaissances

Lorsque les langues sont supprimées ou cachées du site de la base de connaissances, les lecteurs peuvent rencontrer des erreurs 404 s'ils tentent d'accéder aux versions supprimées des articles.

Une fois qu'une langue est retirée du projet, tous les articles associés à cette langue deviennent indisponibles. Cependant, les utilisateurs disposant de liens favoris ou d'un accès direct à ces URLs peuvent tout de même tenter de les ouvrir, ce qui entraîne des erreurs 404.

Étapes à résoudre :

Pour éviter les erreurs 404 et rediriger les utilisateurs vers la version principale de l'article, mettez en place des règles de redirection pour les langues supprimées :

Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers Article redirect rules.
Cliquez sur Nouvelle redirection pour ajouter une nouvelle règle de redirection.
Le nouveau panneau de règles de redirection apparaîtra.
Choisissez Remplacer par dans la section type Redirection.
Dans le chemin Source, entrez /docs/<language_code> (par exemple, /docs/fr pour le français, /docs/es pour l'espagnol, /docs/de pour l'allemand).
Dans le texte Remplacer, saisi / pour rediriger tous les liens d'articles spécifiques à la langue principale.
Cliquez sur Créer pour enregistrer la règle.
Répétez le processus pour chaque langue supprimée. Une fois ces règles de redirection appliquées, toute tentative d'accès à un article supprimé redirige automatiquement les utilisateurs vers la version principale, évitant ainsi les erreurs 404 même si les liens sont mis en favori.

Creating a new redirect rule with source path and replace text fields filled.

FAQ

Qu'est-ce que les liens morts ?

Les liens morts, ou liens cassés, sont des hyperliens qui ne fonctionnent plus en raison de problèmes tels que des changements d'URL, des URL incorrectes ou des articles restreints/privés. Ils aboutissent généralement à une page d'erreur 404.

Qu'est-ce qu'un article slug ?

Un slug est la partie d'une URL qui identifie de manière unique un article ou une page spécifique. Il vient après l' / URL racine de votre projet.

Exemple :
URL de l'article : https://docs.document360.com/docs/why-did-we-build-document360
Limace : /why-did-we-build-document360

Combien de règles de redirection puis-je configurer dans un projet ?

Vous pouvez configurer un maximum de 10 000 règles de redirection par projet. Si vous dépassez la limite, veuillez contacter notre équipe de support.

Y a-t-il des limites pour la fonction de règle de redirection d'importation ?

Vous pouvez importer jusqu'à 1 000 règles de redirection par jour et utiliser la fonction d'importation jusqu'à cinq fois par jour. Si vous dépassez la limite, veuillez contacter notre équipe de support.

Pourquoi est-ce que je vois l'erreur « Le site de la base de données est redirigé trop de fois lorsqu'il est accessible » ?

Cette erreur survient à cause d'une boucle de redirection, souvent causée par la définition de l'URL du site de la base de connaissances Document360 comme URL de connexion pour l'authentification JWT. Assurez-vous que l'URL de connexion pour l'authentification JWT n'est pas la même que l'URL du site Document360 KB. Utilisez une page d'authentification dédiée comme URL de connexion pour éviter les boucles de redirection et résoudre l'erreur.

Comment pouvons-nous résoudre le problème des erreurs 404 lorsque nous abandonnons des fonctionnalités qui mènent à des liens entrants provenant de sources que nous ne pouvons pas contrôler ?

Pour les fonctionnalités abandonnées, afin de gérer efficacement les erreurs 404, créez un article standard informant les utilisateurs de l'abandon d'une fonctionnalité, qui peut être utilisé pour rediriger les articles pertinents.

Pour plusieurs fonctionnalités abandonnées, envisagez d'établir une page centralisée qui consolide toutes les informations associées, garantissant ainsi que les utilisateurs peuvent accéder facilement aux mises à jour et réduisant la fréquence des liens morts.

Comment rediriger un article d'une page à une autre en utilisant JavaScript personnalisé ?

Pour rediriger un article d'une page à une autre en utilisant JavaScript personnalisé, suivez les étapes ci-dessous :

Naviguez vers () > Knowledge base site dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez jusqu Customize site.
Cliquez sur CSS & JavaScript personnalisés.

Collez le code suivant dans l'onglet JavaScript :

$(document).ready(function() {
  if(panel.location.href=="source URL") {
    panel.location.replace("destination URL");
  }
});

Remplacez l' URL source et l'URL de destination dans le code.
Cliquez sur Enregistrer.

Comment puis-je écrire une règle de redirection pour remplacer le nom de l'espace de travail dans l'URL ?

Vous pouvez utiliser des règles de redirection lors de la migration d'une autre plateforme vers Document360.

Ancienne structure d'URL : https://docs.document360.com/{oldworkspace}/section/page
Nouvelle structure d'URL : https://docs.document360.com/{newworkspace}/section/page

Le même domaine doit être mappé sur les deux plateformes pour que la redirection fonctionne. Par exemple,
Si l'ancien espace de travail est v1 et que le nouvel espace est v2 :

Source	Destination	Règne
`/v1`	`/`	fin avec
`/v1/`	`/v2`	remplacer avec

Cette règle garantit que toutes les requêtes pointant vers l'ancien espace de travail v1 sont redirigées vers le nouvel espace de travail v2.

Comment puis-je rediriger l'URL d'un article/catégorie spécifique vers la page d'accueil de ma documentation ?

Pour rediriger une URL spécifique vers la page d'accueil de ma documentation, changez l'URL de destination en '/'.
Par exemple, si vous souhaitez rediriger l'URL https://docs.radixdlt.com/docs/welcome vers https://docs.radixdlt.com , définissez l'URL source comme /docs/welcome et l'URL de destination comme '/' dans la règle de remplacement par redirection.