Hospedando o Document360 em um subdiretório

Planos que suportam hospedagem do Document360 em um subdiretório

O que é hospedagem de subpastas?

A hospedagem de subpastas é um método de organizar e exibir conteúdo em um site usando pastas no domínio principal (raiz). Uma subpasta (também chamada de subdiretório) aparece após o domínio raiz em uma URL e é usada para estruturar o conteúdo logicamente.
Por exemplo, o domínio raiz do Document360 é document360.com. Portanto, um URL de caminho de subpasta/subdiretório pode ser document360.com/docs/.

A maioria das empresas hospeda sua documentação em uma subpasta/subdiretório no domínio do site.
Por exemplo: example.com/docs, example.com/support, etc.

Isso ocorre porque hospedar uma base de conhecimento em um subdiretório/subpasta de um site (example.com/docs) em vez de um subdomínio (docs.example.com) é melhor para Search Engine Optimization (SEO).

NOTA

A hospedagem de subpasta/subdiretório pode ser habilitada para domínios fornecidos pelo Document360 e domínios personalizados mapeados.

Habilitando a hospedagem de subpastas

Para habilitar a hospedagem de subpastas para seu projeto,

1. Navegue até Configurações () na barra de navegação esquerda no Portal da base de conhecimento.

2. No painel de navegação esquerdo, navegue até Site da base de conhecimento > Domínio personalizado > Hospedagem de subpastas guia.

   Por padrão, o caminho da subpasta é definido como /docs.

3. Ative a alternância ao lado de "A base de conhecimento está hospedada como uma subpasta".
   Quando a alternância estiver ativada, a visualização pública dos artigos ficará visível. Isso também impede a inserção do slug da área de trabalho ao inserir links em artigos.

Caminhos de subpasta personalizados

Você também pode configurar sua base de conhecimento em caminhos de subpasta/subdiretório diferentes de /docs.

Por exemplo, /help, /support, etc.

1. Navegue até Configurações () na barra de navegação esquerda no Portal da base de conhecimento.

2. No painel de navegação esquerdo, navegue até Site da base de conhecimento > Domínio personalizado > Hospedagem de subpastas guia.

   Por padrão, o caminho da subpasta é definido como /docs.

3. Desmarque o campo Caminho da subpasta e insira o caminho da subpasta personalizada (por exemplo, /help).

4. Clique no botão Atualização  à direita.

   Essa nova subpasta personalizada só funcionará se a configuração de hospedagem de subpasta estiver habilitada em seu projeto.

Ao configurar outros caminhos, adicione os idiomas associados a cada espaço de trabalho em seu projeto. Essa configuração varia de acordo com os diferentes servidores da web.

NOTA

Para projetos configurados com domínio personalizado e hospedagem de subpastas, a opção de visualização do artigo ainda não é suportada.

Caminhos personalizados da API do site

Para sua informação (FYI)

O recurso de caminhos da API do Site Personalizado está disponível apenas em projetos do site 2.0 da Base de Dados de Conhecimento. Para migrar do site da KB 1.0 para o site da KB 2.0, leia o artigo sobre KB site 2.0 migration.

Por padrão, o caminho da API do site é definido como /api. Você também pode personalizar o caminho da API do site na guia Hospedagem de subpastas nas configurações de domínio personalizadas.

Por exemplo, /docs-api, /api-docs, etc.

CUIDADO

Para projetos do site 2.0 da base de conhecimento , a hospedagem de subpastas funcionará somente quando o caminho da subpasta e o caminho da API do site tiverem sido definidos.

1. Navegue até Configurações () na barra de navegação esquerda no Portal da base de conhecimento.

2. No painel de navegação esquerdo, navegue até Site da base de conhecimento > Domínio personalizado > Hospedagem de subpastas guia.

   Por padrão, o caminho da API do site é definido como /api.

3. Desmarque o campo Caminho da API do site e insira o caminho personalizado da API do site (por exemplo, /docs-api).

4. Clique no botão Atualização  à direita.

   Esse novo caminho de API de site personalizado só funcionará se a configuração de hospedagem de subpasta estiver habilitada em seu projeto.

NOTA

O caminho da API do Site Personalizado não é o caminho para a Documentação da API.

Servidores Web

Aqui estão alguns dos servidores web comumente usados

• Servidor HTTP Apache

• Servidor Nginx

• ASP.NET Servidor núcleo

• Microsoft - Servidor IIS

• Servidor OpenResty

• Servidor LiteSpeed

• Servidor Cloudflare

NOTA

O que é um servidor web?
Um servidor web armazena e entrega o conteúdo de um site – como texto, imagens, vídeo e dados de aplicativos – aos clientes que o solicitam. O tipo mais comum de cliente é um programa de navegador da web.

O que acontece depois?

Depois que o servidor Web for configurado com êxito, seu site da base de conhecimento estará ativo em sua subpasta/subdiretório personalizado. No entanto, a URL existente para seu projeto atenderá às solicitações.
Por exemplo, example.document360.io e example.com/docs (se /docs for o caminho da pasta) apontará para o site da base de conhecimento.

Isso causará conteúdo duplicado nos mecanismos de pesquisa (Google, Bing, etc.). Para isso, você precisará habilitar um redirecionamento de URL.

NOTA

Para habilitar o redirecionamento de example.document360.io para example.com/docs, entre em contato conosco em support@document360.com.

Solucionando problemas

O URL ainda mostra '/docs' apesar de a hospedagem de subpastas estar desativada

Por padrão, a documentação é hospedada na /docs subpasta e esse caminho permanece visível na URL, independentemente de a configuração de hospedagem da subpasta estar ativada ou desativada.

Etapas para resolver:

Para alterar o caminho,

1. Crie uma nova subpasta em seu projeto.

2. Habilite a configuração de hospedagem de subpasta para a subpasta recém-criada.

3. Conclua a configuração necessária para aplicar o caminho de URL personalizado.

Erro 404 devido a '/docs' duplicado na URL canônica

Quando seu site está hospedado em uma /docs subpasta, adicionar /docs o URL canônico faz com que ele apareça duas vezes no URL final (por exemplo, article-name/docs/docs/), levando a um erro 404.

Etapas para resolver:

1. Para corrigir o problema, atualize o URL canônico para incluir apenas o domínio sem o /docs caminho. Por exemplo, defina o URL canônico como: https://yourdomain.com/article-name

2. Isso garante que a /docs subpasta seja adicionada apenas uma vez, mantendo a estrutura de URL correta e evitando erros 404.