Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Apache Flink
- Pisarz techniczny:
- haseeb1431
- Nazwa projektu:
- Rozszerzenie dokumentacji interfejsu Table API i SQL w Apache Flink
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Przesyłam zgłoszenie dotyczące GSOD dotyczącego „Rozszerzenia interfejsu Table API i dokumentacji SQL”. Naszym celem jest napisanie dokumentacji interfejsu API w taki sposób, aby nawet babcia mogła tworzyć zapytania. Możemy już mieć strukturę, ale przejdziemy przez nią jako początkujący użytkownicy i w razie potrzeby zasugerujemy pomysły. Planuję ścisłą współpracę z mentorami, aby poznać ich sposób myślenia i dzielić się różnymi pomysłami opartymi na moim dotychczasowym doświadczeniu w branży.
Oto kilka wstępnych spostrzeżeń na podstawie obecnej dokumentacji:
Strona Przegląd zawiera obecnie dużo informacji, ale należy ją ponownie przejrzeć i uporządkować w taki sposób, aby zarówno początkujący, jak i zaawansowany użytkownik mogli szybko zacząć. Chodzi mi o to, aby przedstawić różne możliwości rozpoczęcia pracy: a) utworzenie nowego projektu, a potem wykonanie w nim zapytań; b) wykonanie zapytań SQL lub zapytań interfejsu Table API w dotychczasowym projekcie.
Na stronie docelowej musi się też znajdować pełna mapa dokumentacji interfejsu API, aby użytkownicy mogli od razu zobaczyć wszystkie możliwości. Będzie to ulepszona wersja sekcji „Co dalej?” na obecnej stronie Przegląd.
Strona koncepcji zawiera całkiem dobre treści, ale jest na niej zbyt dużo informacji, więc podzielimy ją na kilka podsekcje. Podobnie inne sekcje, takie jak Planery, Wbudowane funkcje i Połączenia, powinny być lepiej widoczne, np. na stronie przeglądu lub na pasku nawigacyjnym po lewej stronie. Strona z informacjami o połączeniach może być podzielona na więcej sekcji, np. na sekcje dotyczące połączeń, formatów itp. Funkcje systemowe (wbudowane) wyglądają dobrze, ponieważ mamy wszystkie możliwe metody dostępne na jednej stronie i użytkownicy mogą do nich wracać jako do ściągi, ale chętnie dodamy więcej treści na ten temat.
Ten 3-miesięczny okres będzie podzielony na różne etapy. Najpierw utworzymy strukturę, na przykład mapę witryny, dokumentacji interfejsu Table & SQL API. Przedstawimy podsekcje i sekwencje przedstawione powyżej. Gdy to zrobisz, będziemy mogli przekazać go do sprawdzenia użytkownikom zaawansowanym i początkującym. Z drugiej strony, możemy zacząć pisać o planistach i łącznikach, gdy czekamy na opinie. Gdy otrzymamy Twoją opinię, zmodyfikujemy strukturę dokumentów API. Następnie skupimy się na dokończeniu pisania w oczekujących sekcjach. Na koniec, jeśli pozwoli na to czas, planuję wziąć przykład od podstaw i pokazać kompleksowe wdrożenie projektu, które można wykorzystać w przypadku FLINK-12639.
Po 2 tygodniach proponuję, że możemy umówić się na godzinne spotkanie poza przerwanymi czatami (lub przy użyciu innych narzędzi). Udostępnię Ci wstępny harmonogram projektu z przewidywaną liczbą tygodni, co pomoże nam śledzić postępy projektu również w ujęciu tygodniowym.
Ta dokumentacja jest podobna do naszego bloga na medium.com, gdzie dodajemy wszystkie podstawowe informacje, gdy uczymy się różnych funkcji Flink API. Jestem też wyjątkowym kandydatem, który sprawdza dokumenty przez praktyczne implementacje, a nie tylko pisanie tekstów technicznych. Ten projekt będzie dla mnie prawdziwym przełomem, ponieważ będę pomagać w tworzeniu dokumentacji open source podczas nauki interfejsu Table i SQL API.