Portal de Documentação
Documentação que vive num repositório distante, num PDF desatualizado ou num wiki paralelo é documentação que ninguém lê. E documentação atrás de uma tela de login é documentação que metade das pessoas que precisa dela nunca abre — quem está avaliando a plataforma, quem foi buscar uma resposta antes de pedir acesso, quem recebeu o link de um colega. Por isso o manual do DATTA é um site próprio, aberto, servido em /documentacao/. Você está lendo esta página nele agora.
Como acessar
- Direto, sem login: em
/documentacao/(os endereços/documentacaoe/documentacao.htmllevam ao mesmo lugar). Toda a documentação de produto, uso e administração funcional é aberta: não pede usuário, não pede senha e não depende de a plataforma estar no ar para ser lida. - Pela plataforma: item no menu lateral, que abre o site numa aba nova. Cada página tem URL própria — dá para salvar nos favoritos e mandar o link de qualquer trecho para um colega.
- Seção restrita: Plataforma & Operações — arquitetura interna, runbooks, infraestrutura, instalador e consoles — não fica no site. O endereço dela leva para dentro da plataforma, que pede login e só entrega o conteúdo a quem tem a permissão
PLATFORM_VIEWou perfil de administrador. Entrar na seção já exige login, e não apenas abrir uma página de dentro dela. - O que o site mostra sobre o restrito é só a contagem. Uma seção que tem páginas restritas exibe uma entrada única — "13 páginas restritas" — com cadeado e o caminho para a plataforma. O título de uma página de operações também é informação: nomes como Console do Cluster descrevem a topologia que a própria página protege, então o site não os publica.
Dois idiomas, sem fricção
O portal é bilíngue (português do Brasil e inglês):
- Detecção automática: na primeira visita, o idioma segue o do seu navegador — inglês para navegadores em inglês, português para os demais.
- Troca manual: botões PT | EN no topo. A escolha fica salva no navegador e vale para as próximas visitas.
- Fallback amigável: uma página ainda não traduzida para o inglês exibe a versão em português com um aviso no topo — você nunca cai numa página vazia.
O que o portal oferece
- Busca (
Ctrl/Cmd + K): procura em títulos, descrições e cabeçalhos, nos dois idiomas, com resultados agrupados por seção e navegação por teclado. - Nesta página: sumário lateral com os cabeçalhos da página aberta, para saltar direto à seção desejada (em telas largas).
- Anterior / Próximo: navegação sequencial entre páginas, atravessando seções — dá para ler a documentação como um livro.
- Cards de seção: a página inicial e cada seção mostram cards com título e descrição das páginas.
- Links internos: links entre documentos viram navegação do site; um link para documento restrito vira texto com aviso, nunca um erro nem um link morto.
- Tema e mobile: o site usa a mesma identidade visual da plataforma, segue o tema claro/escuro e é responsivo — a barra lateral vira um menu deslizante em telas pequenas.
- Continua legível sem JavaScript: cada página é um documento HTML servido pronto. Com o JavaScript desligado você perde a busca e o botão de tema; o texto, a navegação e os links continuam funcionando.
Exemplo prático — encontrar a resposta em 30 segundos
- De qualquer página do portal, tecle
Ctrl/Cmd + K. - Digite
triagem. Os resultados aparecem enquanto você digita, agrupados por seção — guias de uso, administração, etc. - Use as setas do teclado para selecionar Triagem em Lote e tecle Enter.
- No painel Nesta página, clique no cabeçalho da dúvida específica — você cai direto na seção, sem rolar o documento inteiro.
- Quer mandar para um colega de outro país? Clique em EN e compartilhe a URL — ela abre na versão em inglês.
De onde vem o conteúdo
O site é gerado junto com a plataforma, a partir da base de documentação do próprio produto. Três consequências práticas para quem lê:
- O que você vê corresponde à versão instalada. Não há sincronização manual entre a documentação e o sistema — atualizar a plataforma atualiza o site.
- Cada página existe em português e inglês. O português é a fonte; quando a tradução ainda não existe, a página é servida em português e sinalizada como tal, em vez de aparecer vazia.
- A página é escrita no momento da geração, não montada no seu navegador. É o que permite que ela abra rápido, seja indexável e não dependa de sessão.
A documentação é publicada em duas partições. A pública — guias de uso, administração e API — é o site aberto. A de Plataforma & Operações reúne runbooks, infraestrutura, instalador e arquitetura interna, que descrevem endereços de rede, comandos e topologia: ela nunca entra no site, e é entregue dentro da plataforma apenas a quem tem permissão (PLATFORM_VIEW), por um caminho autenticado. A separação é verificada a cada geração — nos dois sentidos, inclusive conferindo que nenhuma página restrita virou arquivo do site — e coberta por teste automatizado.
Páginas relacionadas: navegação do shell, controle de acesso e permissões.