Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Apache Flink
- Redactor técnico:
- Kartik Khare
- Nombre del proyecto:
- Extiende la API de Table y la documentación de SQL
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Flink SQL es muy prometedor. La idea de que puedes trabajar en flujos solo con SQL es obvia, pero complicada. Creo que Flink SQL puede eliminar, en última instancia, la necesidad de que los ingenieros de datos realicen análisis triviales sobre datos en tiempo real, como contar las solicitudes de Uber/Lyft en varias ciudades en tiempo real. El primer paso para lograr este objetivo es simplificar la documentación de modo que alguien con experiencia en analítica también pueda comenzar.
Estas son algunas de las mejoras que planeo hacer en los documentos. Podemos analizar más al respecto cuando empecemos con la documentación: * La página de resumen no contiene ningún ejemplo. Debe contener ejemplos sencillos para proporcionar una introducción a la API de Table. * Se debe dividir la página Conceptos y APIs comunes. * Las funciones deben tener una página independiente para cada categoría. Las funciones también deben aparecer en una lista tabular con el nombre, los datos de entrada, los parámetros (si los hay) y el valor que se muestra como columnas. * La página Data Type debe contener las asignaciones adecuadas de tipo de datos de Java → tipo de datos de SQL. La representación actual está en forma de párrafos, pero lo ideal sería que fuera una tabla. * La sección Sintaxis de la expresión en la página de la API de Table debería tener un mejor formato. * Una página completamente nueva sobre los planificadores y cómo los usuarios pueden aprovecharlos. * Una página sobre optimizaciones que se encuentran dispersas por varias secciones en este momento. También debe cambiar el formato de la página Descripción general de SQL.
El contenido también necesita una reelaboración, ya que parece un poco abrumador. También necesitamos agregar una sección en la que puedas usar la API de Table en lugar de la API de transmisión con comparaciones como una disminución en las líneas de código, mejores optimizaciones implícitas, una mejor legibilidad y una depuración más sencilla.