Cambio del título de un artículo
A veces, es necesario cambiar el título de un artículo de ayuda. Hay varias consideraciones que se deben tener en cuenta al cambiar el título de un artículo.
Información general sobre cómo cambiar el nombre de archivo
El título del artículo corresponde directamente al nombre del archivo Markdown que contiene ese artículo, por un par de motivos:
- Optimización del motor de búsqueda: cuando usamos palabras reales que guardan correlación con el contenido del artículo en una dirección URL, nuestros artículos se ponderan con un peso mayor para los motores de búsqueda. Para obtener más información, consulta "Mejorar la estructura de las direcciones URL" en la guía de inicio de optimización del motor de búsqueda de Google.
Lugares cuya actualización debes considerar al cambiar un título
Es posible que tengas que actualizar varios lugares al asignar un nuevo título a un artículo.
Texto preliminar y sección de metadatos
Cada artículo contiene una sección de metadatos o texto preliminar ubicados en la parte superior del artículo al que se le ha aplicado formato mediante la sintaxis de YAML. Esta sección de metadatos genera el título del artículo y contiene otros datos importantes, como redirecciones y, a veces, incluso referencias de contenido de descripción breve que se vinculan a texto de introducción reutilizable.
---
title: Your article name
intro:
redirect_from:
- /articles/older-outdated-article-name/
---
Lista de comprobación de actualización de texto preliminar
- Actualización del título mediante mayúscula inicial
- Actualiza las redirecciones. Casi cada vez que cambiamos el título de un artículo, debemos agregar una redirección que haga referencia a la dirección URL antigua del artículo y asegurarnos de mantener las redirecciones en el texto preliminar del artículo anterior.
Filename
Puedes usar el comando git mv en el terminal para cambiar el nombre del archivo.
$ git mv old-article-name.md new-article-name.md
Archivo de índice primario
Asegúrate de actualizar el vínculo al archivo en su archivo index.md primario, que genera la Tabla de contenidos.
Vínculos insertados dentro de otros artículos
Vinculamos artículos de nuestra documentación. Se recomienda buscar el nombre de archivo y el título para encontrar vínculos que actualizar.
Vínculos en GitHub
Busca vínculos al título anterior en el producto. Si encuentras vínculos obsoletos, ponte en contacto con el equipo o los ingenieros pertinentes para informarles de que el vínculo ha cambiado y pedirles que lo actualicen. Si no estás seguro de con quién debes ponerte en contacto, puedes preguntar a un miembro del equipo de GitHub Docs. Como cortesía, también puedes crear una PR con los vínculos actualizados y pedir al equipo pertinente que la combine después de enviarse el título del artículo actualizado.