Thanks for driving this effort Marta. I'd be up for mentoring improvements for the deployment section as described in FLIP-42.
Cheers, Till On Fri, Apr 17, 2020 at 11:20 AM Aljoscha Krettek <aljos...@apache.org> wrote: > Hi, > > first, excellent that you're driving this, Marta! > > By now I have made quite some progress on the FLIP-42 restructuring so > that is not a good effort for someone to join now. Plus there is also > [1], which is about incorporating the existing Flink Training material > into the concepts section of the Flink doc. > > What I think would be very good is working on the Table API/SQL > documentation [2]. We don't necessarily have to take the FLIP as a basis > but we can, or we can start from a blank slate. I think the current > structure as well as the content is sub-optimal (not good, really). It > would be ideal to have someone get to now the system and then write > documentation for that part of Flink that has both good structure and > content and nicely guides new users. > > I would be very happy to mentor that effort. > > Best, > Aljoscha > > [1] > > https://lists.apache.org/thread.html/rea9cbfffd9a1c0ca6f78f7e8c8497d81f32ed4a7b9e7a05d59f3b2e9%40%3Cdev.flink.apache.org%3E > > [2] > https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=127405685 > > On 17.04.20 09:21, Robert Metzger wrote: > > Thanks a lot for volunteering to drive an application for the Flink > project! > > > > Last year, we discussed finishing the chinese translation as a potential > > project. I believe there's still a need for this. > > Since the work on the project starts pretty far in the future > (September), > > the translation project is a good fit as well (there's currently no major > > effort on the translation, rather a constant flow of PRs, but I don't > think > > that is enough to finish the translation). > > > > > > On Fri, Apr 17, 2020 at 9:15 AM Konstantin Knauf <kna...@apache.org> > wrote: > > > >> Hi Marta, > >> > >> Thanks for kicking off the discussion. Aljoscha has recently revived the > >> implementation of the FLIP-42 and has already moved things around quite > a > >> bit. [1] > >> > >> There are a lot of areas that can be improved of course, but a lot of > them > >> require very deep knowledge about the system (e.g. the "Deployment" or > >> "Concepts" section). One area that I could imagine working well in such > a > >> format is to work on the "Connectors" section. Aljoscha has already > moved > >> this to the top-level, but it besides that it has not been touched yet > in > >> the course of FLIP-42. The documentation project could be around > >> restructuring, standardization and generally improving the > documentation of > >> our connectors for both Datastream as well as Table API/SQL. > >> > >> Cheers, > >> > >> Konstantin > >> > >> [1] https://ci.apache.org/projects/flink/flink-docs-master/ > >> > >> On Wed, Apr 15, 2020 at 12:11 PM Marta Paes Moreira < > ma...@ververica.com> > >> wrote: > >> > >>> Hi, Everyone. > >>> > >>> Google is running its Season of Docs [1] program again this year. The > >> goal > >>> of the program is to pair open source organizations/projects with > >>> professional technical writers to improve their documentation. > >>> > >>> The Flink community submitted an application in 2019 (led by > Konstantin) > >>> [2,3], but was unfortunately not accepted into the program. This year, > >> I'm > >>> volunteering to write and submit the proposal in the upcoming weeks. To > >>> achieve this, there are a few things that need to be sorted out in > >> advance: > >>> > >>> - > >>> *Mentors *Each proposed project idea requires at least two volunteers > to > >>> mentor technical writers through the process. *Who would like to > >>> participate as a mentor*? You can read about the responsibilities > here > >>> [4]. > >>> > >>> > >>> - > >>> *Project Ideas *We can submit as many project ideas as we'd like, but > >> it's > >>> unlikely that more than 2 are accepted. *What would you consider a > >>> priority for documentation improvement*? In my opinion, > reorganizing > >> the > >>> documentation to make it easier to navigate and more accessible to > >>> newcomers would be a top priority. You can check > FLIP-42/FLINK-12639 > >> [5] > >>> for improvements that are already under consideration and [6] for > last > >>> year's mailing list discussion. > >>> > >>> > >>> - *Alternative Organization Administrator* > >>> I volunteer as an administrator, but Google requires two. *Who > would > >>> like to join me as an application administrator*? > >>> > >>> The deadline is *May 4th *and the accepted projects would kick-off the > >> work > >>> with technical writers on *September 14th*. Let me know if you have any > >>> questions! > >>> > >>> Thanks, > >>> > >>> Marta > >>> > >>> [1] https://developers.google.com/season-of-docs > >>> [2] > >>> > >>> > >> > https://lists.apache.org/thread.html/3c789b6187da23ad158df59bbc598543b652e3cfc1010a14e294e16a@%3Cdev.flink.apache.org%3E > >>> [3] > >>> > >>> > >> > https://docs.google.com/document/d/1Up53jNsLztApn-mP76AB6xWUVGt3nwS9p6xQTiceKXo/edit?usp=sharing > >>> [4] https://developers.google.com/season-of-docs/docs/mentor-guide > >>> [5] https://issues.apache.org/jira/browse/FLINK-12639 > >>> [6] > >>> > >>> > >> > https://lists.apache.org/thread.html/3c789b6187da23ad158df59bbc598543b652e3cfc1010a14e294e16a@%3Cdev.flink.apache.org%3E > >>> > >> > >> > >> -- > >> > >> Konstantin Knauf > >> > > > >
