Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Apache Flink
- Rédacteur technique:
- Kartik Khare
- Nom du projet:
- Étendre la documentation de l'API Table et de SQL
- Durée du projet:
- Durée standard (trois mois)
Project description
Flink SQL est très prometteur. L'idée que vous pouvez travailler sur des flux en utilisant uniquement SQL est évidente, mais complexe. Je pense que Flink SQL peut à terme supprimer le besoin d'ingénieurs en données pour les analyses triviales sur les données en temps réel, comme le comptage des demandes d'Uber/Lyft dans différentes villes en temps réel. La première étape consiste à simplifier la documentation afin qu'une personne ayant des connaissances en analyse puisse également se lancer.
Voici quelques-unes des améliorations que je prévois pour les documents. Nous en parlerons plus en détail lorsque nous commencerons à utiliser la documentation. * La page "Vue d'ensemble" ne contient aucun exemple. Il doit contenir des exemples simples pour présenter l'API Table. * La page "Concepts et API communes" doit être divisée. * Chaque fonction doit avoir une page distincte pour chaque catégorie. Les fonctions doivent également être listées sous forme de tableau, avec le nom, les données d'entrée, les paramètres (le cas échéant) et la valeur de retour en tant que colonnes. * La page "Type de données" doit contenir des mappages appropriés entre les types de données JAVA et SQL. La représentation actuelle se présente sous forme de paragraphes, mais idéalement, elle devrait être un tableau. * La section "Syntaxe de l'expression" sur la page de l'API Table devrait avoir une meilleure mise en forme. * Une toute nouvelle page sur les planificateurs montrant comment les utilisateurs peuvent en tirer parti. * Une page sur les optimisations qui sont actuellement dispersées dans plusieurs sections. La page "Présentation de SQL" doit également être mise en forme.
Le contenu doit également être retravaillé, car il semble un peu écrasant. Nous devons également ajouter une section sur les cas d'utilisation de l'API Table au lieu de l'API Streaming, avec des comparaisons telles qu'une diminution du nombre de lignes de code, de meilleures optimisations implicites, une meilleure lisibilité et un débogage plus facile.