Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- Apache Flink
- Rédacteur technique:
- haseeb1431
- Nom du projet:
- Extension de l'API Table et de la documentation SQL pour Apache Flink
- Durée du projet:
- Durée standard (3 mois)
Project description
Je soumets ma candidature pour le GSOD sur "Extend the Table API & SQL Documentation". Nous allons rédiger la documentation de l'API afin que ma grand-mère puisse également écrire des requêtes. Même si nous avons déjà une structure, nous allons l'examiner en tant qu'utilisateurs novices et suggérer des idées chaque fois que nécessaire. Je prévois de travailler en étroite collaboration avec des mentors pour comprendre leur processus de réflexion tout en partageant différentes idées en fonction de mon expérience dans le secteur.
Voici quelques idées initiales basées sur la documentation actuelle:
La page "Vue d'ensemble" contient actuellement beaucoup d'informations, mais elle doit être réorganisée et triée de manière à permettre à un utilisateur débutant et à un utilisateur avancé de commencer rapidement. L'idée est de proposer une introduction avec différentes pistes possibles : a) démarrer un nouveau projet, puis exécuter les requêtes dessus ; b) exécuter des requêtes SQL ou Table API sur un projet existant.
Nous devons également disposer d'une carte complète de la documentation de l'API sur la page de destination afin que les utilisateurs puissent voir toutes les possibilités au premier coup d'œil. Il s'agit d'une version améliorée de la section "Où aller ensuite ?" de la page d'aperçu actuelle.
Le contenu de la page de concept est plutôt bon, mais il est trop condensé sur une seule page. Nous allons donc avoir peu de sous-sections sur cette page. De même, les sections "Planificateurs", "Fonctions intégrées" et "Connecteurs" ont besoin de plus de visibilité, par exemple sur la page "Vue d'ensemble" ou la barre de navigation de gauche. La page "Connecteurs" peut être divisée en plusieurs sous-sections (connecteurs, formats, etc.). Les fonctions système (intégrées) me semblent bien, car toutes les méthodes possibles sont disponibles sur une seule page et les utilisateurs peuvent s'y référer comme à une aide-mémoire. Je serais toutefois ravi d'ajouter d'autres contenus à ce sujet.
La période de trois mois sera divisée en différentes phases. Nous allons d'abord créer une structure, comme un sitemap, de la documentation de l'API Table et SQL. Nous ajouterons des sous-sections et des histoires comme indiqué ci-dessus. Une fois terminé, nous pourrons le faire examiner par des utilisateurs avancés et débutants. D'un autre côté, nous pouvons commencer à écrire sur les planificateurs et les connecteurs en attendant les commentaires. Une fois que nous aurons reçu vos commentaires, nous restructurerons notre documentation sur les API. Nous allons maintenant nous concentrer sur la fin de la rédaction des sections en attente. Enfin, si le temps me le permet, je prévois de prendre un exemple de zéro et de présenter l'implémentation de bout en bout d'un projet qui peut être exploité pour FLINK-12639.
Je propose que nous organisions une réunion d'une heure dans deux semaines, en dehors des discussions sur Slack (ou tout autre outil). Je vais vous communiquer un calendrier initial du projet avec les semaines prévues, ce qui nous aidera également à suivre sa progression chaque semaine.
Enfin, cette documentation est semblable à notre blog sur medium.com, où nous ajoutons toutes les informations de base lorsque nous apprenons les différentes fonctionnalités de l'API Flink. Cela me rend également unique en tant que candidat, car je vais valider la documentation avec des implémentations pratiques plutôt que de me contenter d'écrire les documents techniques. Ce projet sera un double avantage pour moi, car je contribuerai à la documentation Open Source tout en apprenant l'API Table et SQL.