На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Апач Флинк
- Технический писатель:
- Картик Харе
- Название проекта:
- Расширение документации по Table API и SQL
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Flink SQL демонстрирует ошеломляющие перспективы. Идея о том, что вы можете работать с потоками, используя только SQL, очевидна, но сложна. Я считаю, что Flink SQL может в конечном итоге избавить инженеров по обработке данных от необходимости выполнять тривиальный анализ данных в реальном времени, например подсчет запросов на Uber/Lyft в различных городах в реальном времени. Первым шагом на пути к этой цели является упрощение документации, чтобы человек с опытом работы в области аналитики мог также начать работу.
Вот некоторые улучшения, которые я планирую в документации. Мы сможем обсудить их подробнее, когда начнем работать с документацией — * Страница обзора не содержит примеров. Он должен содержать простые примеры для ознакомления с API таблиц. * Страница «Концепции и общий API» должна быть разделена. * Функции должны иметь отдельную страницу для каждой категории. Функции также должны быть перечислены в табличной форме с именем, входными данными, параметрами (если таковые имеются) и возвращаемым значением в виде столбцов. * Страница «Тип данных» должна содержать правильные сопоставления типа данных JAVA → типа данных SQL. Текущее представление представлено в форме абзацев, но в идеале это должна быть таблица. * Раздел «Синтаксис выражений» на странице API таблиц должен иметь лучшее форматирование. * Совершенно новая страница о планировщиках и о том, как пользователи могут ими воспользоваться. * Страница об оптимизации, которая сейчас разбросана по нескольким разделам. Страницу обзора SQL также необходимо переформатировать.
Содержание также нуждается в переработке, поскольку оно кажется немного подавляющим. Нам также необходимо добавить раздел о том, где вы можете использовать Table API вместо Streaming API, с такими сравнениями, как уменьшение количества строк кода, лучшая неявная оптимизация, лучшая читаемость и упрощение отладки.