Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Apache Flink
- Technischer Redakteur:
- haseeb1431
- Projektname:
- Erweiterung der Table API und SQL-Dokumentation für Apache Flink
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
Ich reiche meinen Antrag für den GSOD zum Thema „Extend the Table API & SQL Documentation“ ein. Wir werden eine API-Dokumentation erstellen, damit auch Oma Abfragen schreiben kann. Möglicherweise haben wir die Struktur bereits, aber wir gehen sie als neue Nutzer durch und schlagen bei Bedarf Ideen vor. Ich möchte eng mit Mentoren zusammenarbeiten, um ihren Denkprozess zu verstehen und gleichzeitig verschiedene Ideen auf der Grundlage meiner bisherigen Branchenerfahrungen zu teilen.
Einige der ersten Überlegungen basierend auf der aktuellen Dokumentation:
Die Übersichtsseite enthält derzeit viele Informationen, die aber überarbeitet und so angeordnet werden müssen, dass sowohl Anfänger als auch Fortgeschrittene schnell loslegen können. Meine Idee ist, mit verschiedenen möglichen Tracks zu beginnen, a) ein neues Projekt zu starten und dann die Abfragen darüber auszuführen, b) SQL- oder Table API-Abfragen zusätzlich zu einem bestehenden Projekt auszuführen.
Außerdem muss auf der Landingpage eine vollständige Übersicht der API-Dokumentation vorhanden sein, damit Nutzer alle Möglichkeiten auf einen Blick sehen. Es handelt sich um eine verbesserte Version des Abschnitts „Nächste Schritte“ auf der aktuellen Übersichtsseite.
Die Konzeptseite enthält ziemlich gute Inhalte, aber sie ist zu voll auf einer einzigen Seite. Wir werden daher nur wenige Unterabschnitte auf dieser Seite haben. Auch andere Bereiche wie Planer, integrierte Funktionen und Connectors benötigen mehr Sichtbarkeit, etwa auf der Übersichtsseite oder auf der linken Navigationsleiste. Die Seite „Connectors“ kann in weitere Unterbereiche unterteilt werden, z.B. „Connectors“, „Formate“ usw. Systemfunktionen (integriert) sehen gut aus, da alle verfügbaren Methoden auf einer einzigen Seite zur Verfügung stehen und die Nutzer sie immer als Spickzettel bezeichnen können, aber gerne weitere Inhalte dazu hinzufügen.
Der Zeitraum von drei Monaten wird in verschiedene Phasen unterteilt. Zuerst erstellen wir eine Struktur, ähnlich einer Sitemap, der Dokumentation der Table & SQL API. Wir werden Unterabschnitte und Storylines einführen, wie oben beschrieben. Sobald Sie fertig sind, können wir es mit Nutzern auf fortgeschrittenem und Anfängerniveau überprüfen. Während wir auf das Feedback warten, können wir auch schon über die Planer und Connectors schreiben. Sobald wir das Feedback erhalten haben, werden wir unsere API-Dokumente umstrukturieren. Als Nächstes konzentrieren wir uns darauf, den Text für die ausstehenden Abschnitte fertigzustellen. Wenn es Zeit bleibt, werde ich ein Beispiel von Grund auf neu erstellen und eine vollständige Projektimplementierung zeigen, die für FLINK-12639 genutzt werden kann.
Ich schlage vor, dass wir nach zwei Wochen ein einstündiges Meeting abhalten, anstatt über Slack (oder andere Tools) zu chatten. Ich werde einen ersten Projektzeitplan mit den voraussichtlichen Wochen teilen, damit wir den Projektfortschritt auch wöchentlich verfolgen können.
Schließlich ähnelt diese Dokumentation unserem Blog auf medium.com, in dem wir alle grundlegenden Details hinzufügen, wenn wir die verschiedenen Funktionen der Flink API kennenlernen. Außerdem bin ich ein einzigartiger Kandidat, da ich die Dokumentation anhand praktischer Implementierungen überprüfe, anstatt nur die technischen Dokumente zu verfassen. Dieses Projekt wird für mich als Doppelschwert funktionieren, da ich zur Open-Source-Dokumentation beitragen werde, während ich die Table and SQL API erlerne.