Sobre os redirecionamentos
Se uma alteração for feita em um artigo que afete a capacidade das pessoas de encontrá-lo, criaremos um redirecionamento de quaisquer versões desatualizadas para o conteúdo atual. Talvez seja necessário fazer isso se o título de um artigo for alterado, uma nova versão for adicionada ou o local do arquivo for alterado.
Os redirecionamentos podem ser configurados local ou externamente.
Configurar os redirecionamentos locais
No GitHub Docs, você pode redirecionar de um arquivo para outro ou de uma versão para outra.
Redirecionamentos entre arquivos
Se você alterar o nome de um artigo e quiser que a URL antiga redirecione para a nova URL em todas as versões, use o front matter redirect_from com o caminho para o nome antigo do artigo. Se você alterar o nome de um artigo e quiser que versões diferentes redirecionem para URLs diferentes, siga as etapas na seção Redirecionamentos entre versões.
No exemplo a seguir, o artigo “Tudo sobre compromissos” foi renomeado para “Criar seu primeiro compromisso”. O front matter redirect_from redireciona qualquer pessoa que navegue para a URL do artigo antigo para a URL do novo artigo.
title: Creating your first commit
redirect_from:
- /content/get-started/all-about-commits
Confira redirect_from no arquivo Leiame do GitHub Docs para obter mais detalhes.
Redirecionamentos automáticos para URLs que não incluem uma versão
Se um URL para uma página for inserido sem uma versão (https://docs.github.com/ARTICLE em vez de https://docs.github.com/VERSION/ARTICLE), o site vai redirecioná-lo automaticamente para a primeira versão disponível da página.
A ordem de precedência é especificada em lib/all-versions.ts. A ordem de precedência atual é:
- GitHub Free, GitHub Pro ou GitHub Team (
fpt) - GitHub Enterprise Cloud (
ghec) - GitHub Enterprise Server (
ghes)
Se um título de página ARTICLE estiver disponível apenas em GitHub Enterprise Cloud e GitHub Enterprise Server, o link https://docs.github.com/ARTICLE será redirecionado automaticamente para https://docs.github.com/enterprise-cloud@latest/ARTICLE porque GitHub Enterprise Cloud tem precedência sobre GitHub Enterprise Server.
Se ARTICLE estiver disponível em Free, Pro ou Team, nenhum redirecionamento ocorrerá porque as páginas fpt não têm um segmento de versão, portanto, o conteúdo fpt em https://docs.github.com/ARTICLE será renderizado.
Redirecionamentos entre versões
Se quiser que a URL de uma versão de um artigo redirecione para uma URL de outra versão ou para outra URL, atualize o arquivo redirect-exceptions.txt no diretório src/redirects.
Por exemplo, se você remover a versão Free, Pro ou Team (fpt) de um artigo, a URL será redirecionada automaticamente para a próxima versão disponível da página. Se você quiser que redirecione para uma versão inferior na ordem de precedência ou para uma página totalmente diferente, especifique uma exceção.
Cada entrada no arquivo redirect-exceptions deve começar com o caminho para o qual você deseja redirecionar, incluindo a versão, seguido por uma lista não ordenada dos caminhos dos quais você deseja redirecionar. No exemplo a seguir, os caminhos na lista não ordenada redirecionarão para a versão GitHub Enterprise Cloud de Exportando as informações de integrante para a sua organização.
/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
- /[email protected]/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
- /[email protected]/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
- /[email protected]/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
Configurar os redirecionamentos externos
Raramente, o conteúdo será movido para fora do site do GitHub Docs. Para esses tipos de redirecionamentos, atualize o arquivo external-sites.json no diretório src/redirects.
Cada entrada no arquivo external-sites.json é um par chave-valor em que a chave é o caminho para onde o conteúdo estava e o valor é o caminho para onde ele deve redirecionar.
"/github-status": "https://www.githubstatus.com/",
"/articles/github-security": "https://github.com/security",