Onde a documentação está
- Repositório:
ClickHouse/ClickHouse(docs/nesta árvore) - Formato: MDX, gerado com Mintlify
- Localização:
docs/integrations/<category>/<your-integration>/, em que<category>reflete o que seu produto faz (data-visualization,data-ingestion,language-clientse assim por diante) - Processo: abra um pull request para a
master. A equipe de integrações do ClickHouse faz a revisão. Quem contribui pela primeira vez assina o Contributor License Agreement quando o bot solicita no PR. Consulte o guia de contribuição para a documentação para visualizar localmente (mint deva partir dedocs/)
Escolhendo uma categoria
Seções obrigatórias
- Objetivo. Qual problema a integração resolve, em duas ou três frases. Evite texto de marketing. Em geral, os leitores são engenheiros avaliando uma implementação
- Pré-requisitos e matriz de versões compatíveis. O que o usuário precisa ter instalado e quais versões são compatíveis com ClickHouse Cloud e ambientes self-hosted (open source). Uma tabela pequena funciona bem
- Passo a passo da configuração. Instruções passo a passo até obter uma conexão funcional, com cobertura lado a lado de Cloud e self-hosted quando houver diferenças (host, porta, TLS)
- Autenticação. Quais modos de autenticação têm suporte (nome de usuário e senha via TLS, no mínimo, além de mTLS, certificado de cliente SSL e observações sobre lista de permissões de IP, se relevante)
- Exemplo de ponta a ponta. Pelo menos um exemplo realista, da conexão até um resultado relevante. Use um dataset de exemplo do ClickHouse para que os leitores possam reproduzi-lo
- Limites conhecidos e características de desempenho. Lacunas no sistema de tipos, limites de result-set, observações sobre throughput e recursos sem suporte. Ser transparente aqui reduz ciclos de suporte
- Solução de problemas. Erros comuns e suas resoluções. Dois ou três casos frequentes bastam para uma primeira versão
Observações de estilo
- Mostre Cloud e self-hosted. Cloud normalmente usa HTTPS na porta
8443e native TCP na9440. Self-hosted usa8123e9000por padrão - Use callouts do Mintlify (
<Note>,<Warning>,<Tip>) para observações em vez de parágrafos em negrito - Inclua links para mais detalhes. Use links para a documentação existente sobre tipos de dados, formatos, JDBC, ClickPipes e tópicos semelhantes, em vez de explicá-los novamente
- Sem marketing. As páginas de integração aqui são referências técnicas. Conteúdo promocional deve ficar no seu site; podemos incluir um link para ele no diretório de parceiros
Modelo base para copiar e colar
docs/integrations/<category>/<your-integration>/index.mdx e abra um PR.