À propos des redirections
Si une modification est apportée à un article qui affecte la capacité des personnes à le trouver, nous créons une redirection de toutes les versions obsolètes vers le contenu actuel. Nous devrons peut-être le faire si le titre d’un article est modifié, si une nouvelle version est ajoutée ou si l’emplacement du fichier est modifié.
Les redirections peuvent être configurées localement ou en externe.
Configurer des redirections locales
Dans les données GitHub Docs, vous pouvez rediriger d’un fichier vers un autre ou d’une version vers une autre.
Redirections entre les fichiers
Si vous modifiez le nom d’un article et souhaitez que son ancienne URL soit redirigée vers sa nouvelle URL, utilisez l’information préliminaire redirect_from avec le chemin d’accès à l’ancien nom de l’article. Si vous modifiez le nom d’un article et souhaitez que différentes versions soient redirigées vers différentes URL, suivez les étapes de la section « Redirections entre versions ».
Dans l’exemple suivant, l’article « Tout sur les validations » a été renommé en « Créer votre première validation ». L’information préliminaire redirect_from redirige toute personne qui accède à l’ancienne URL de l’article vers la nouvelle URL de l’article.
title: Creating your first commit
redirect_from:
- /content/get-started/all-about-commits
Pour plus d’informations, consultez redirect_from dans le fichier Lisez-moi GitHub Docs.
Redirections automatiques pour les URL qui n’incluent pas de version
Si une URL pour une page est entrée sans version (https://docs.github.com/ARTICLE au lieu de https://docs.github.com/VERSION/ARTICLE), le site la redirige automatiquement vers la première version disponible de la page.
L’ordre de précédence est spécifié dans lib/all-versions.js. L’ordre de précédence actuel est :
- GitHub Free, GitHub Pro ou GitHub Team (
fpt) - GitHub Enterprise Cloud (
ghec) - GitHub Enterprise Server (
ghes)
Si une page intitulée ARTICLE n’est disponible que dans GitHub Enterprise Cloud et GitHub Enterprise Server, le lien https://docs.github.com/ARTICLE sera automatiquement redirigé vers https://docs.github.com/enterprise-cloud@latest/ARTICLE, car GitHub Enterprise Cloud a la précédence sur GitHub Enterprise Server.
Si ARTICLE est disponible dans Free, Pro ou Team, aucune redirection ne se produit, car les pages fpt n’ont pas de segment de version, de sorte que le contenu fpt à https://docs.github.com/ARTICLE sera affiché.
Redirections entre les versions
Si vous souhaitez que l’URL d’une version d’un article soit redirigée vers l’URL d’une autre version ou vers une autre URL, vous devez mettre à jour le fichier redirect-exceptions.txt dans le répertoire src/redirects.
Par exemple, si vous supprimez la version Free, Pro ou Team (fpt) d’un article, l’URL redirige automatiquement vers la prochaine version disponible de la page. Si vous souhaitez qu’elle redirige vers une version inférieure dans l’ordre de précédence ou vers une page complètement différente, vous devez spécifier une exception.
Chaque entrée du fichier redirect-exceptions doit commencer par le chemin vers lequel vous souhaitez effectuer une redirection, y compris la version, suivie d’une liste non triée des chemins d’accès depuis lequels vous souhaitez effectuer une redirection. Dans l’exemple suivant, les chemins d’accès de la liste non triée redirigent vers la version GitHub Enterprise Cloud de « Exportation des informations sur les membres de votre organisation ».
/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
- /enterprise-server@3.3/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
- /enterprise-server@3.4/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
- /enterprise-server@3.5/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
Configurer des redirections externes
Rarement, le contenu se déplace en dehors du site GitHub Docs. Pour ces types de redirections, mettez à jour le fichier external-sites.json dans le répertoire src/redirects.
Chaque entrée du fichier external-sites.json est une paire clé-valeur où la clé est le chemin d’accès à l’emplacement où se trouvait le contenu et la valeur est le chemin d’accès à l’emplacement où il doit être redirigé.
"/github-status": "https://www.githubstatus.com/",
"/articles/github-security": "https://github.com/security",