Hi Aizhamal, hi everyone, Thanks for sharing this opportunity with our community! I can think of a few projects that could be done as part of GSoD.
1) Flink's user documentation is (IMO) fairly extensive and mostly complete, but its structure could be improved in some areas (event-time, state management). 2) We are lacking some good tutorials to get started with Flink (Docker-based setup, SQL + SQL Client, Table API, ...) 3) More documentation on Flink's internals (mostly relevant for people contributing to Flink) would be great to have. Looking at the timeline for GSoD, I see that the documentation work would start in September. Although there is a good chance that some of these issues will still be present in five months from now, I don't think we would hold them back in case somebody wants to start an effort to work on them. There have been some efforts and also a PR [1] to improve some aspects of the documentation. Unfortunately, the linked PR was not merged yet due to lack of committer involvement. Obviously, we would need at least two mentors (I think at least one should be a committer) who dedicate a good amount of their time for the GSoD project. Is there somebody in the community, who would be interested in being a mentor for GSoD? Best, Fabian [1] https://github.com/apache/flink/pull/6481 Am Sa., 6. Apr. 2019 um 00:44 Uhr schrieb Aizhamal Nurmamat kyzy <aizha...@google.com.invalid>: > Hello everyone, > > TL;DR If you need some improvements for Flink documentation, apply to > Season of Docs before April 23rd. > > Background: > > Season of Docs is like Google Summer of Code, but for documentation. > Projects write ideas on how they would like to improve their documentation, > then if they are accepted to the program, they will get a professional tech > writer to work on the project’s documentation for 3 months. Technical > writer’s get stipend from Google. > > If you think that Apache Flink could benefit from it, please submit the > application before April 23rd. > > The program requires two administrators, to manage the organization's > participation in SoD, and at least two mentors to onboard tech writers to > the project, and work with them closely during 3 months period [2]. To be a > mentor in this program, you don't have to be a technical writer, but you > must know Flink and the open source well to onboard/introduce tech writers > to the project, and be able to support them during the whole process. > > I am an administrator for 2 Apache projects, and will be more than happy to > share my knowledge on this, if you, as an organization decide to apply. > > I think it will be great if Flink participates in it too! > > Thanks, > Aizhamal > > [1] https://developers.google.com/season-of-docs/ > [2] https://developers.google.com/season-of-docs/docs/timeline >
