Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- Apache Flink
- Redator técnico:
- haseeb1431
- Nome do projeto:
- Extensão da API de tabelas e documentação do SQL para o Apache Flink
- Duração do projeto:
- Duração padrão (três meses)
Project description
Estou enviando minha inscrição para o GSOD em "Estender a documentação da API e do SQL da tabela". Vamos criar a documentação da API para que a vovó também possa escrever consultas. Embora já tenhamos a estrutura, vamos analisá-la como usuários iniciantes e sugerir ideias sempre que necessário. Pretendo trabalhar em estreita colaboração com os mentores para entender o processo de pensamento deles e compartilhar ideias diferentes com base na minha experiência anterior no setor.
Algumas das ideias iniciais com base na documentação atual são:
No momento, a página de visão geral tem muitas informações, mas precisa ser revisada e organizada de uma forma que usuários iniciantes e avançados possam começar rapidamente. Minha ideia é começar com diferentes opções possíveis: a) iniciar um novo projeto e executar as consultas nele; b) executar consultas da API SQL ou Tabela em um projeto existente.
Também precisamos ter um mapa completo da documentação da API na página de destino para que os usuários possam conferir todas as possibilidades de relance. Ela será uma versão aprimorada da seção "Próximos passos" na página de visão geral atual.
A página de conceito tem um conteúdo muito bom, mas está muito apertada em uma única página. Por isso, vamos ter algumas subseções nessa página. Da mesma forma, outras seções, como "Planners", "Built-in functions" e "Connectors", precisam de mais visibilidade, talvez na página de visão geral ou na barra de navegação à esquerda. A página de conectores pode ser dividida em mais subseções, por exemplo, conectores, formatos etc. As funções de sistema (integradas) parecem boas, porque temos todos os métodos possíveis disponíveis em uma única página, e os usuários podem sempre se referir a elas como folhas de referências, mas ficarão felizes em adicionar mais conteúdo sobre isso.
O período de três meses será dividido em diferentes fases. Inicialmente, vamos criar uma estrutura, como um sitemap, da documentação da API Table & SQL. Vamos apresentar subseções e histórias, como mencionado acima. Depois que for concluído, ele poderá ser analisado com usuários avançados e iniciantes. Por outro lado, podemos começar a escrever sobre os planejadores e conectores enquanto aguardamos o feedback. Assim que recebermos o feedback, vamos reestruturar nossos documentos de API. Em seguida, vamos nos concentrar em terminar a redação das seções pendentes. Por fim, se o tempo permitir, pretendo usar um exemplo do zero e mostrar um caso de implementação de projeto completo que pode ser aproveitado para o FLINK-12639.
Proponho que podemos ter uma reunião de uma hora após duas semanas, além dos chats no Slack (ou qualquer outra ferramenta). Vou compartilhar um cronograma inicial do projeto com as semanas previstas, o que também vai nos ajudar a acompanhar o progresso do projeto semanalmente.
Por fim, esta documentação é semelhante ao nosso blog no medium.com, em que adicionamos todos os detalhes básicos ao aprendermos diferentes funcionalidades da API Flink. Isso também me torna um candidato único, porque vou verificar a documentação com implementações práticas, em vez de apenas escrever os documentos técnicos. Esse projeto vai funcionar como uma espada de dois gumes para mim, porque vou contribuir com a documentação de código aberto enquanto aprendo sobre a API Table e SQL.