Skip to main content

Esta versão do GitHub Enterprise Server foi descontinuada em 2024-03-26. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Como alterar o título de um artigo

Quando é necessário alterar o título de um artigo, talvez seja preciso atualizar o nome em vários locais.

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:

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.

Vinculamos os artigos em nossa documentação. Recomendamos pesquisar o nome de arquivo e o título para localizar os links para atualização.

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.