Como alterar o título de um artigo
Às vezes, é necessário alterar o título de um artigo de ajuda. Há várias considerações a serem feitas quando o título de um artigo é alterado.
Informações de referência sobre a alteração do nome de arquivo
O título do artigo corresponde diretamente ao nome do arquivo Markdown que contém esse artigo, por alguns motivos:
- SEO: quando usamos palavras reais que se correlacionam com o conteúdo do artigo em uma URL, nossos artigos são ponderados mais intensamente nos mecanismos de pesquisa. Para obter mais informações, confira "Aprimorar a estrutura das URLs" no Guia Inicial de Otimização do Mecanismo de Pesquisa do Google.
Locais que você deve considerar atualizar ao alterar um título
Há vários locais que talvez você precise atualizar ao dar um novo título a um artigo.
Seção de metadados e matéria frontal
Cada artigo contém uma seção de metadados ou uma matéria frontal localizada na parte superior do artigo formatada com a sintaxe YAML. Essa seção de metadados gera o título do artigo e contém outros dados importantes, como redirecionamentos e, às vezes, até mesmo referências contextuais de descrição curta que são vinculadas ao texto de introdução reutilizável.
---
title: Your article name
intro:
redirect_from:
- /articles/older-outdated-article-name/
---
Lista de verificação de atualizações da matéria frontal
- Atualize o título usando maiúsculas só na primeira palavra
- Atualize os redirecionamentos. Quase toda vez que redirecionamos um artigo, devemos adicionar um redirecionamento que referencie a URL antiga do artigo e garantir que mantenhamos os redirecionamentos na matéria frontal do artigo antigo.
Nome de arquivo
Você pode usar o comando git mv no terminal para alterar o nome do arquivo.
$ git mv old-article-name.md new-article-name.md
Arquivo de índice pai
Atualize o link para o arquivo no arquivo pai index.md, que gera o sumário.
Links embutidos em outros artigos
Vinculamos os artigos em nossa documentação. Recomendamos pesquisar o nome de arquivo e o título para localizar os links para atualização.
Links no GitHub
Pesquise no produto links para o título antigo. Caso encontre links desatualizados, entre em contato com a equipe ou os engenheiros relevantes para informá-los que o link foi alterado e peça que eles o atualizem. Se não tiver certeza com quem deve entrar em contato, pergunte a um membro da equipe do GitHub Docs. Como cortesia, você também pode criar uma pull request com os links atualizados e pedir à equipe relevante para mesclá-la após o título do artigo atualizado ser fornecido.