flink-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Fabian Hueske <fhue...@gmail.com>
Subject Re: [DISCUSS] Reorganize Table API / SQL documentation
Date Tue, 23 May 2017 15:25:28 GMT
Hi everybody,

I prepared a branch that creates the proposed structure and copied the
existing documentation into the corresponding pages / sections.
There are plenty of gaps that need to be filled or reworked.

--> https://github.com/fhueske/flink/tree/tableDocs

How do we go on from here?
I think the easiest would be if everybody who's interested in working on
the documentation picks a page and prepares a PR against my branch (we
could also push this into a feature branch in the Flink repository if
somebody prefers that). The PRs are cross-checked and we merge everything
into to the master when the docs are ready.

Any opinions or other proposals?

Cheers, Fabian

2017-05-23 10:31 GMT+01:00 Fabian Hueske <fhueske@gmail.com>:

> Hi everybody,
>
> Thanks for the feedback. I'll go ahead and create the proposed structure
> and move the content of the existing docs with comments of what needs to be
> adapted.
> I'll put this into branch of my Github repo and let you know when I'm done.
> From there, we can distribute working on the missing parts / parts that
> need adaption.
>
> Cheers, Fabian
>
> 2017-05-19 9:44 GMT+01:00 jincheng sun <sunjincheng121@gmail.com>:
>
>> Hi, Fabian,
>>
>>   Thanks for the sketch. The structure is pretty well to me, And glad to
>> join in the discussion in google doc.
>>
>> Cheers,
>> SunJincheng
>>
>> 2017-05-19 14:55 GMT+08:00 Shaoxuan Wang <wshaoxuan@gmail.com>:
>>
>> > Hello Fabian,
>> > Thanks for drafting the proposal. I like the entire organization in
>> general
>> > and left a few comments. I think this will be a very good kick off to
>> > reorganize the tableAPI&SQL doc.
>> >
>> > -shaoxuan
>> >
>> > On Fri, May 19, 2017 at 7:06 AM, Fabian Hueske <fhueske@gmail.com>
>> wrote:
>> >
>> > > Hi everybody,
>> > >
>> > > I came up with a proposal for the structure of the Table API / SQL
>> > > documentation:
>> > >
>> > > https://docs.google.com/document/d/1ENY8tcPadZjoZ4AQ_
>> > > lRRwWiVpScDkm_4rgxIGWGT5E0/edit?usp=sharing
>> > >
>> > > Feedback and comments are very welcome.
>> > > Once we agree on a structure, we can create skeletons and distribute
>> the
>> > > work.
>> > >
>> > > Cheers,
>> > > Fabian
>> > >
>> > > 2017-05-18 21:01 GMT+02:00 Haohui Mai <ricetons@gmail.com>:
>> > >
>> > > > +1
>> > > >
>> > > > The Table / SQL component has made significant progress in the last
>> few
>> > > > months (kudos to all contributors).
>> > > >
>> > > > It is a good time to have a documentation to reflect all the
>> changes in
>> > > the
>> > > > Table / SQL side.
>> > > >
>> > > >
>> > > >
>> > > > On Thu, May 18, 2017 at 8:12 AM Robert Metzger <rmetzger@apache.org
>> >
>> > > > wrote:
>> > > >
>> > > > > Thank you Fabian for working on the proposal.
>> > > > >
>> > > > > On Thu, May 18, 2017 at 3:51 PM, Fabian Hueske <fhueske@gmail.com
>> >
>> > > > wrote:
>> > > > >
>> > > > > > Thanks for starting this discussion Robert.
>> > > > > >
>> > > > > > I think with the next release the Table API / SQL should
be
>> moved
>> > up
>> > > in
>> > > > > the
>> > > > > > Application Development menu.
>> > > > > > I also though about restructuring the docs, but it won't
be
>> trivial
>> > > to
>> > > > do
>> > > > > > this, IMO because there are many orthogonal aspects:
>> > > > > > - Stream/Batch
>> > > > > > - Table/SQL
>> > > > > > - Scala/Java
>> > > > > >
>> > > > > > and sometimes also common concepts.
>> > > > > > At the moment there are also many new features missing like
OVER
>> > > > windows,
>> > > > > > UDAGGs, retraction, StreamTableSinks, time indicator attributes,
>> > > filter
>> > > > > > pushdown, ...
>> > > > > >
>> > > > > > I will try to sketch a new structure in a Google Doc in
the next
>> > days
>> > > > and
>> > > > > > share it in this thread.
>> > > > > >
>> > > > > > Cheers, Fabian
>> > > > > >
>> > > > > > 2017-05-18 14:03 GMT+02:00 Kostas Kloudas <
>> > > k.kloudas@data-artisans.com
>> > > > >:
>> > > > > >
>> > > > > > > A big +1 as well.
>> > > > > > >
>> > > > > > > > On May 18, 2017, at 1:55 PM, Ufuk Celebi <uce@apache.org>
>> > wrote:
>> > > > > > > >
>> > > > > > > > On Thu, May 18, 2017 at 1:52 PM, Till Rohrmann
<
>> > > > trohrmann@apache.org
>> > > > > >
>> > > > > > > wrote:
>> > > > > > > >> I think we have a history of creating too
long monolithic
>> > > > > > documentation
>> > > > > > > >> pages which are hard to digest. So a big +1
for splitting
>> the
>> > > > Table
>> > > > > > > API/SQL
>> > > > > > > >> documentation up into more easily digestible
pieces.
>> > > > > > > >
>> > > > > > > > +1
>> > > > > > > >
>> > > > > > > > Thanks for bringing it up
>> > > > > > >
>> > > > > > >
>> > > > > >
>> > > > >
>> > > >
>> > >
>> >
>>
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message