Regra de redirecionamento de artigos

Planos que suportam este recurso: Professional Business Enterprise

Você pode configurar uma regra de redirecionamento de artigo para qualquer URL publicada ou rascunha. O recurso de redirecionamento é útil quando você muda a URL de um artigo e essa mesma URL já foi referenciada em outros artigos no seu site da Knowledge Base. Você também pode fazer uma importação em massa das regras de redirecionamento.

Regras de redirecionamento impedem que usuários cliquem em links mortos ou quebrados.

Adicionar uma regra de redirecionamento de artigo

Você pode alterar a URL ou slug de um artigo antes ou depois de publicar a página do artigo ou da categoria. A URL de uma categoria de tipo índice também pode ser modificada. Você pode fazer essas alterações diretamente no editor de artigos.

Para adicionar a regra de redirecionamento de artigos, siga os passos abaixo:

Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Regras de redirecionamento de artigo.
A página de regras de redirecionamento de artigos aparecerá com uma lista de regras existentes (se houver).
Clique em Novo redirecionamento para criar uma nova regra de redirecionamento.
O novo painel de regras de redirecionamento vai aparecer.
Selecione o tipo de Redirecionamento desejado:
a. Termina com: Para definir a regra de redirecionamento para um artigo com o slug único no final da sua URL.
b. Substituir por: Para definir a regra de redirecionamento para o texto URL entre o nome de domínio e o slug do artigo.
NOTA
No campo de regra de Redirecionamento , os seguintes caracteres especiais são suportados: # % ^ & _ - + = | . ? /

Overview of article redirect rules in a knowledge base management system interface.

Termina com

No campo Caminho de Origem , digite o slug único no final da sua URL para o redirecionamento.

NOTA
O slug de URL no caminho de origem deve começar com uma barra direta (/).

No campo URL de destino , digite a URL de destino completa ou digite o novo slug para redirecionamento. Adicionar uma barra para frente (/) no início da URL de destino é opcional.

Exemplo: Para redirecionar a URL do artigo de https://docs.document360.com/docs/getting-started-with-document360 para https://docs.document360.com/docs/getting-started-video-library, adicione o caminho de origem e a URL de destino conforme mencionado abaixo:
Caminho de origem: /getting-started-with-document360
URL de destino: getting-started-video-library

Clique em Criar.

Substitua por

No campo Caminho de Fonte , digite o texto entre o domínio e o slug do artigo que você quer redirecionar.

Exemplo: O caminho de origem na URL https://project.technicaldocumentation.com/v1/docs/fr/getting-started é /v1/docs/fr/.

NOTA
O caminho da fonte deve começar e terminar com uma barra para frente (/).

No campo Substituir texto , digite o novo texto URL que deseja usar para redirecionamento.

Exemplo: Substitua /v1/docs/fr/ por /v2/docs/en/ na URL https://project.technicaldocumentation.com/v1/docs/fr/getting-started.

NOTA
O texto de substituição deve começar e terminar com uma barra para frente (/).

Clique em Criar.

Melhores práticas

Se você gerencia uma base de conhecimento multilíngue com múltiplos espaços de trabalho de projeto, defina regras de redirecionamento baseadas no idioma ou espaço de trabalho. Por exemplo, se você definir uma regra com o caminho /customer-support de origem e o destino /sales-and-support, isso se aplica apenas à linguagem padrão do workspace principal.

Para aplicar essa regra a outro idioma (por exemplo, alemão: /de/), crie uma nova regra com o caminho /de/customer-support de origem e o destino /de/sales-and-support.
Para aplicar a regra em outro espaço de trabalho (por exemplo, versão 1: /v1/), defina o caminho /v1/docs/customer-support de origem e o destino /v1/docs/sales-and-support.

Regra de redirecionamento em nível de local

Na página de regras de redirecionamento de artigos , você pode definir uma regra de redirecionamento de subpasta no nível do site usando a opção Substituir por . Isso é útil para migrar de outra plataforma ou redirecionar espaços de trabalho/idiomas removidos ou ocultos.

Exemplo: Defina uma regra de redirecionamento para a subpasta /azure/serverless em /data/cloud360 URLs como https://apidocs.serverless360.com/azure/serverless/article_slug.

Editando uma regra de redirecionamento

Para editar a regra de redirecionamento de artigos, siga os passos abaixo:

Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Regras de redirecionamento de artigo.
A página de regras de redirecionamento de artigos aparecerá com uma lista de regras existentes (se houver).
Use o Filtro para encontrar a regra de redirecionamento desejada.
Passe o mouse sobre a regra desejada e clique no ícone Editar ().
O painel de regras de redirecionamento de edição vai aparecer.
Atualize o(s) campo(s) necessário(s).
Clique em Atualizar.

Excluindo uma regra de redirecionamento

Para excluir uma regra de redirecionamento de artigo, siga os passos abaixo:

Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Regras de redirecionamento de artigo.
A página de regras de redirecionamento de artigos aparecerá com uma lista de regras existentes (se houver).
Use o Filtro para encontrar a regra de redirecionamento desejada.
Passe o mouse sobre a regra desejada e clique no ícone Excluir ().
Para deletar várias regras, selecione as caixas de seleção ao lado das regras e clique em Deletar.
Clique em sim no painel de confirmação Excluir .

NOTA
Regras de redirecionamento deletadas não podem ser recuperadas.

Filtrar uma regra de redirecionamento

Para filtrar a regra de redirecionamento desejada, siga os passos abaixo:

Busca: Insira uma palavra-chave do caminho de origem ou URL de destino na barra de busca, e o resultado é preenchido.
Tipo: Filtrar pelo tipo de redirecionamento: Termina com, Substitui com, ou Ambos.
Data de modificação: Filtre regras pela última data de modificação, com opções como 1 ano, 3 meses, 30 dias ou 7 dias. Clique em Data Personalizada para escolher qualquer faixa de data personalizada e selecione a faixa de datas desejada.

Importação de regras de redirecionamento

Para importar regras de redirecionamento em massa de uma vez, envie um CSV que corresponda ao seguinte modelo:

Fonte	Destino	RedirecionaTipo
`/myoldarticle`	`newarticle`	Fim com
`/en/customers/`	`/v1/docs/`	substituir, com

NOTA
O tamanho do arquivo deve ser menor ou igual a 1MB.

Importar o modelo de arquivo de redirecionamento de regra,

Você também pode baixar o modelo aqui:

import-redirect-rule.csv

Para importar regras de redirecionamento em massa:

Prepare um arquivo CSV que corresponda ao modelo fornecido (tamanho do arquivo ≤ 1MB).
Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Regras de redirecionamento de artigo.
Clique na regra de importação de redirecionamento.
O painel de regras de importação de redirecionamento vai aparecer.
Arraste e solte o arquivo CSV ou selecione Clique para Enviar.
Revise a lista de regras válidas e inválidas.
NOTA
Clique no ícone Download () próximo à contagem de regras inválidas para baixar a lista de regras inválidas.
Clique em Importar para aplicar as regras válidas.

Regras de redirecionamento de exportação

Para exportar regras de redirecionamento como um arquivo CSV, siga os passos abaixo:

Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Regras de redirecionamento de artigo.
Clique em Exportar para baixar as regras como um arquivo CSV.

Solução de problemas

Artigo publicado redirecionando ou mostrando um erro 404

Um artigo publicado no site da base de conhecimento pode redirecionar para outro artigo ou causar um erro 404 devido a uma regra de redirecionamento mal configurada aplicada ao link do artigo.

Passos para resolver:

Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Regras de redirecionamento de artigo.
Use a barra de busca para encontrar o slug do artigo e verificar se uma regra de redirecionamento foi aplicada.
Se uma regra de redirecionamento for aplicada, revise seu propósito. Se a regra for desnecessária ou estiver mal configurada, remova-a.
Salve as alterações e revise o artigo para garantir que ele seja exibido conforme esperado no site da Knowledge Base.

Se o problema persistir após seguir essas etapas, entre em contato com a equipe de suporte do Document360 para obter mais assistência: Entre em contato com o suporte do Document360

Encontrando um erro ao salvar uma regra de redirecionamento de artigo.

Erro: Falharam ao salvar a regra de redirecionamento de artigos. A fonte dada já faz parte de um destino existente.

Esse erro ocorre quando um slug de destino (o alvo de uma regra de redirecionamento existente) é usado como caminho de origem para outro redirecionamento. Uma vez que um destino é definido em uma regra de redirecionamento, ele se torna um alvo estático e não pode ser reutilizado como fonte em uma nova regra.

Passos para resolver:

Certifique-se de que o slug de destino não seja usado como caminho de origem em nenhuma regra de redirecionamento existente ou nova.
Revise e atualize suas regras de redirecionamento para evitar conflitos.

An error message indicating failure to save article redirection rule in the Knowledge base portal.

Evitando erros 404 após remover linguagens no site da base de conhecimento

Quando linguagens são removidas/ocultadas do site da Knowledge Base, os leitores podem encontrar erros 404 se tentarem acessar versões em idiomas removidos dos artigos.

Uma vez que uma língua é removida do projeto, todos os artigos associados a esse idioma tornam-se indisponíveis. No entanto, usuários com links favoritos ou acesso direto a essas URLs ainda podem tentar abri-las, levando a erros 404.

Passos para resolver:

Para evitar erros 404 e redirecionar os usuários para a versão principal do artigo, estabeleça regras de redirecionamento para os idiomas removidos:

Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Regras de redirecionamento de artigo.
Clique em Novo redirecionamento para adicionar uma nova regra de redirecionamento.
O novo painel de regras de redirecionamento vai aparecer.
Escolha Substituir por na seção de tipo Redirecionamento .
No caminho Fonte, insira /docs/<language_code> (por exemplo, /docs/fr para francês, /docs/es espanhol, /docs/de alemão).
No texto Substituir, insira / para redirecionar todos os links específicos de artigos do idioma para o idioma principal.
Clique em Criar para salvar a regra.
Repita o processo para cada idioma removido. Uma vez aplicadas essas regras de redirecionamento, qualquer tentativa de acessar um artigo em idioma removido redirecionará automaticamente os usuários para a versão principal, evitando erros 404 mesmo que os links estejam marcados nos favoritos.

Creating a new redirect rule with source path and replace text fields filled.

Perguntas Freqüentes

O que são links mortos?

Links mortos, ou links quebrados, são hiperlinks que não funcionam mais devido a problemas como mudanças de URL, URLs incorretas ou artigos restritos/privados. Normalmente, elas resultam em uma página de erro 404.

O que é um slug de artigo?

Um slug é a parte de uma URL que identifica de forma única um artigo/página específica. Ele vem depois do / URL raiz do seu projeto.

Exemplo:
URL do artigo: https://docs.document360.com/docs/why-did-we-build-document360
Lesma: /why-did-we-build-document360

Quantas regras de redirecionamento posso configurar em um projeto?

Você pode configurar no máximo 10.000 regras de redirecionamento por projeto. Se você ultrapassar o limite, por favor, entre em contato com nossa equipe de suporte.

Existem limites para o recurso de regras de importação de redirecionamento?

Você pode importar até 1.000 regras de redirecionamento por dia e usar o recurso de importação até cinco vezes por dia. Se você ultrapassar o limite, por favor, entre em contato com nossa equipe de suporte.

Por que vejo o erro "O site da KB é redirecionado muitas vezes quando acessado?"

Esse erro ocorre devido a um loop de redirecionamento, frequentemente causado pela definição da URL do site da base de conhecimento do Document360 como a URL de login para autenticação JWT. Certifique-se de que a URL de login para autenticação JWT não seja a mesma que a URL do site do Document360 KB. Use uma página dedicada de autenticação como URL de login para evitar loops de redirecionamento e resolver o erro.

Como podemos resolver o problema dos erros 404 quando descontinuamos funcionalidades que levam a links recebidos de fontes que não podemos controlar?

Para recursos descontinuados, para gerenciar efetivamente os erros 404, crie um artigo padrão informando os usuários sobre a descontinuação de uma funcionalidade, que pode ser usado para redirecionar artigos relevantes.

Para múltiplas funcionalidades descontinuadas, considere estabelecer uma página centralizada que consolide todas as informações relacionadas, garantindo que os usuários possam acessar facilmente atualizações e reduzindo a ocorrência de links inativos.

Como faço para redirecionar um artigo de uma página para outra usando JavaScript personalizado?

Para redirecionar um artigo de uma página para outra usando JavaScript Personalizado, siga os passos abaixo:

Navegue até Configurações () > Site da base de conhecimento na barra de navegação à esquerda do portal da Base de Conhecimento.
No painel de navegação à esquerda, navegue até Personalizar site.
Clique em CSS & JavaScript Personalizados.

Cole o seguinte código na aba JavaScript :

$(document).ready(function() {
  if(panel.location.href=="source URL") {
    panel.location.replace("destination URL");
  }
});

Substitua a URL de origem e a URL de destino no código.
Clique em Salvar.

Como faço para escrever uma regra de redirecionamento para substituir o nome do workspace na URL?

Você pode usar regras de redirecionamento ao migrar de uma plataforma diferente para o Document360.

Estrutura antiga de URLs: https://docs.document360.com/{oldworkspace}/section/page
Nova estrutura de URL: https://docs.document360.com/{newworkspace}/section/page

O mesmo domínio deve ser mapeado para ambas as plataformas para que o redirecionamento funcione. Por exemplo,
Se o workspace antigo for v1 e o novo workspace for v2:

Fonte	Destino	Governo
`/v1`	`/`	Fim com
`/v1/`	`/v2`	substituir, com

Essa regra garante que todas as requisições apontadas para o antigo workspace v1 sejam redirecionadas para o novo workspace v2.

Como posso redirecionar uma URL específica de artigo/categoria para a página inicial da minha documentação?

Para redirecionar uma URL específica para a página inicial da minha documentação, mude a URL de destino como '/'.
Por exemplo, se você quiser redirecionar a URL para , defina a URL de origem como /docs/welcome e a URL de destino como '/' na regra de substituir por redirecionamento .