Changement du titre d’un article
Parfois, il est nécessaire de changer le titre d’un article d’aide. Il y a plusieurs considérations à prendre en compte quand vous changez le titre d’un article.
Contexte du changement du nom de fichier
Le titre de l’article correspond directement au nom du fichier Markdown qui contient cet article, ceci pour deux raisons :
- SEO : Quand nous utilisons des mots réels qui correspondent au contenu de l’article dans une URL, nos articles ont un poids plus important pour les moteurs de recherche. Pour plus d’informations, consultez « Améliorer la structure de vos URL » dans le Google Search Engine Optimization Starter Guide (Guide de démarrage sur l’optimisation du moteur de recherche Google).
Emplacements que vous devez envisager de mettre à jour quand vous changez un titre
Quand vous donnez un nouveau titre à un article, il peut être nécessaire de le mettre à jour à plusieurs endroits.
Section frontmatter et metadata
Chaque article contient une section metadata ou frontmatter située en haut de l’article mis en forme en utilisant la syntaxe YAML. Cette section metadata génère le titre de l’article et contient d’autres données importantes, comme des redirections, et parfois même des références à des descriptions courtes qui sont un lien vers du texte d’introduction réutilisable.
---
title: Your article name
intro:
redirect_from:
- /articles/older-outdated-article-name/
---
Checklist pour la mise à jour de frontmatter
- Mettre à jour le titre en utilisant la casse d’une phrase
- Mettre à jour les redirections. Presque chaque fois que nous changeons le titre d’un article, nous devons ajouter une redirection référençant l’ancienne URL de l’article et veiller à conserver toutes les redirections dans le frontmatter de l’ancien article.
Nom de fichier
Vous pouvez utiliser la commande git mv dans votre terminal pour changer le nom du fichier.
$ git mv old-article-name.md new-article-name.md
Fichier d’index parent
Veillez à mettre à jour le lien vers le fichier dans son fichier index.md parent, qui génère la table des matières (TOC).
Liens inline dans d’autres articles
Nous établissons des liens entre les articles de notre documentation. Nous recommandons de rechercher à la fois le nom de fichier et le titre pour trouver des liens à mettre à jour.
Liens dans GitHub
Recherchez dans le produit des liens vers l’ancien titre. Si vous trouvez des liens obsolètes, contactez l’équipe ou les ingénieurs concernés pour leur faire savoir que le lien a changé et leur demander de le mettre à jour. Si vous ne savez pas qui contacter, vous pouvez demander à un membre de l’équipe GitHub Docs. Vous pouvez aussi (ce serait très apprécié) créer une demande de tirage avec les liens mis à jour et demander à l’équipe concernée de la fusionner après la publication du titre de l’article mis à jour.