That's a good point. We should point readers in the documentation to the repository first, and then write "for convenience, you can also download a snapshot of the repository here" AND put a disclaimer on the page, that this archive is not an official product released by the Flink PMC.
Since this is not on the official download page, and clearly in the context of a "playground" or "demonstration", people will not assume a proper release. Do you think that is okay, or should we reach out to somebody at the foundation? On Fri, Jul 12, 2019 at 12:09 PM Chesnay Schepler <ches...@apache.org> wrote: > Wouldn't this qualify for releasing snapshot artifacts to users? (Which, > you know, shouldn't be done?) > > On 12/07/2019 11:55, Robert Metzger wrote: > > I will request the repo now, so that you can continue working on the > > documentation (thanks for that again :) ) > > > > > > I actually like Xuefu's idea of making an archive available. > > The good thing is that we can get this from any GitHub hosted repository. > > For example for Flink, this link let's you download an archive of Flink's > > latest master: https://github.com/apache/flink/archive/master.zip > > We would not need to set up any additional automation for this. > > > > > > > > On Fri, Jul 12, 2019 at 11:51 AM Konstantin Knauf < > konstan...@ververica.com> > > wrote: > > > >> Hi everyone, > >> > >> thanks everyone for you remarks and questions! We have three +1s, so I > >> think, we can proceed with this. > >> > >> @Robert: Could you create the request to the INFRA? > >> > >> Thanks, > >> > >> Konstantin > >> > >> On Fri, Jul 12, 2019 at 10:16 AM Stephan Ewen <se...@apache.org> wrote: > >> > >>> I am fine with a separate repository, was just raising the other option > >> as > >>> a question. > >>> > >>> +1 to go ahead > >>> > >>> On Fri, Jul 12, 2019 at 9:49 AM Konstantin Knauf < > >> konstan...@ververica.com > >>> wrote: > >>> > >>>> Hi Xuefu, > >>>> > >>>> thanks for having a look at this. I am sure this playground setup will > >>> need > >>>> to be maintained and will go through revisions, too. So, we would > still > >>>> need to keep the content of the archive in some repository + the > >>> additional > >>>> piece of automation to update the archive, when the documentation is > >>> build. > >>>> To me this seems to be more overhead than a repository. > >>>> > >>>> Best, > >>>> > >>>> Konstantin > >>>> > >>>> > >>>> On Thu, Jul 11, 2019 at 9:00 PM Xuefu Z <usxu...@gmail.com> wrote: > >>>> > >>>>> The idea seems interesting, but I'm wondering if we have considered > >>>>> publishing .tz file hosted somewhere in Flink site with a link in the > >>>> doc. > >>>>> This might avoid the "overkill" of introducing a repo, which is main > >>> used > >>>>> for version control in development cycles. On the other hand, a > >> docker > >>>>> setup, once published, will seldom (if ever) go thru revisions. > >>>>> > >>>>> Thanks, > >>>>> Xuefu > >>>>> > >>>>> > >>>>> > >>>>> On Thu, Jul 11, 2019 at 6:58 AM Konstantin Knauf < > >>>> konstan...@ververica.com > >>>>> wrote: > >>>>> > >>>>>> Hi Stephan, > >>>>>> > >>>>>> putting it under "flink-quickstarts" alone would not help. The user > >>>> would > >>>>>> still need to check out the whole `apache/flink` repository, which > >>> is a > >>>>> bit > >>>>>> overwhelming. The Java/Scala quickstarts use Maven archetypes. Is > >>> this > >>>>> what > >>>>>> you are suggesting? I think, this would be an option, but it seems > >>>>> strange > >>>>>> to manage a pure Docker setup (eventually maybe only one file) in a > >>>> Maven > >>>>>> project. > >>>>>> > >>>>>> Best, > >>>>>> > >>>>>> Konstantin > >>>>>> > >>>>>> On Thu, Jul 11, 2019 at 3:52 PM Stephan Ewen <se...@apache.org> > >>> wrote: > >>>>>>> Hi all! > >>>>>>> > >>>>>>> I am fine with a separate repository. > >>>>>>> > >>>>>>> Quick question. though: Have you considered putting the setup not > >>>> under > >>>>>>> "docs" but under "flink-quickstart" or so? > >>>>>>> Would that be equally cumbersome for users? > >>>>>>> > >>>>>>> Best, > >>>>>>> Stephan > >>>>>>> > >>>>>>> > >>>>>>> On Thu, Jul 11, 2019 at 12:19 PM Fabian Hueske < > >> fhue...@gmail.com> > >>>>>> wrote: > >>>>>>>> Hi, > >>>>>>>> > >>>>>>>> I think Quickstart should be as lightweight as possible and > >>> follow > >>>>>> common > >>>>>>>> practices. > >>>>>>>> A Git repository for a few configuration files might feel like > >>>>>> overkill, > >>>>>>>> but IMO it makes sense because this ensures users can get > >> started > >>>>> with > >>>>>> 3 > >>>>>>>> commands: > >>>>>>>> > >>>>>>>> $ git clone .../flink-playground > >>>>>>>> $ cd flink-playground > >>>>>>>> $ docker-compose up -d > >>>>>>>> > >>>>>>>> So +1 to create a repository. > >>>>>>>> > >>>>>>>> Thanks, Fabian > >>>>>>>> > >>>>>>>> Am Do., 11. Juli 2019 um 12:07 Uhr schrieb Robert Metzger < > >>>>>>>> rmetz...@apache.org>: > >>>>>>>> > >>>>>>>>> +1 to create a repo. > >>>>>>>>> > >>>>>>>>> On Thu, Jul 11, 2019 at 11:10 AM Konstantin Knauf < > >>>>>>>>> konstan...@ververica.com> > >>>>>>>>> wrote: > >>>>>>>>> > >>>>>>>>>> Hi everyone, > >>>>>>>>>> > >>>>>>>>>> in the course of implementing FLIP-42 we are currently > >>>> reworking > >>>>>> the > >>>>>>>>>> Getting Started section of our documentation. As part of > >>> this, > >>>> we > >>>>>> are > >>>>>>>>>> adding docker-compose-based playgrounds to get started with > >>>> Flink > >>>>>>>>>> operations and Flink SQL quickly. > >>>>>>>>>> > >>>>>>>>>> To reduce as much friction as possible for new users, we > >>> would > >>>>> like > >>>>>>> to > >>>>>>>>>> maintain the required configuration files > >>> (docker-comose.yaml, > >>>>>>>>>> flink-conf.yaml) in a separate new repository, > >>>>>>>>> `apache/flink-playgrounds`. > >>>>>>>>>> You can find more details and a brief discussion on this in > >>> the > >>>>>>>>>> corresponding Jira ticket [2]. > >>>>>>>>>> > >>>>>>>>>> What do you think? > >>>>>>>>>> > >>>>>>>>>> I am not sure, what kind of approval is required for such a > >>>>> change. > >>>>>>> So, > >>>>>>>>> my > >>>>>>>>>> suggestion would be that we have lazy majority within the > >>> next > >>>> 24 > >>>>>>> hours > >>>>>>>>> to > >>>>>>>>>> create the repository, we proceed. Please let me know, if > >>> this > >>>>>>>> requires a > >>>>>>>>>> more formal approval. > >>>>>>>>>> > >>>>>>>>>> Best and thanks, > >>>>>>>>>> > >>>>>>>>>> Konstantin > >>>>>>>>>> > >>>>>>>>>> [1] > >>>>>>>>>> > >>>>>>>>>> > >> > https://cwiki.apache.org/confluence/display/FLINK/FLIP-42%3A+Rework+Flink+Documentation > >>>>>>>>>> [2] https://issues.apache.org/jira/browse/FLINK-12749 > >>>>>>>>>> > >>>>>>>>>> > >>>>>>>>>> -- > >>>>>>>>>> > >>>>>>>>>> Konstantin Knauf | Solutions Architect > >>>>>>>>>> > >>>>>>>>>> +49 160 91394525 > >>>>>>>>>> > >>>>>>>>>> > >>>>>>>>>> Planned Absences: 10.08.2019 - 31.08.2019, 05.09. - > >>> 06.09.2010 > >>>>>>>>>> > >>>>>>>>>> -- > >>>>>>>>>> > >>>>>>>>>> Ververica GmbH | Invalidenstrasse 115, 10115 Berlin, > >> Germany > >>>>>>>>>> -- > >>>>>>>>>> > >>>>>>>>>> Ververica GmbH > >>>>>>>>>> Registered at Amtsgericht Charlottenburg: HRB 158244 B > >>>>>>>>>> Managing Directors: Dr. Kostas Tzoumas, Dr. Stephan Ewen > >>>>>>>>>> > >>>>>> > >>>>>> -- > >>>>>> > >>>>>> Konstantin Knauf | Solutions Architect > >>>>>> > >>>>>> +49 160 91394525 > >>>>>> > >>>>>> > >>>>>> Planned Absences: 10.08.2019 - 31.08.2019, 05.09. - 06.09.2010 > >>>>>> > >>>>>> > >>>>>> -- > >>>>>> > >>>>>> Ververica GmbH | Invalidenstrasse 115, 10115 Berlin, Germany > >>>>>> > >>>>>> -- > >>>>>> > >>>>>> Ververica GmbH > >>>>>> Registered at Amtsgericht Charlottenburg: HRB 158244 B > >>>>>> Managing Directors: Dr. Kostas Tzoumas, Dr. Stephan Ewen > >>>>>> > >>>>> > >>>>> -- > >>>>> Xuefu Zhang > >>>>> > >>>>> "In Honey We Trust!" > >>>>> > >>>> > >>>> -- > >>>> > >>>> Konstantin Knauf | Solutions Architect > >>>> > >>>> +49 160 91394525 > >>>> > >>>> > >>>> Planned Absences: 10.08.2019 - 31.08.2019, 05.09. - 06.09.2010 > >>>> > >>>> > >>>> -- > >>>> > >>>> Ververica GmbH | Invalidenstrasse 115, 10115 Berlin, Germany > >>>> > >>>> -- > >>>> > >>>> Ververica GmbH > >>>> Registered at Amtsgericht Charlottenburg: HRB 158244 B > >>>> Managing Directors: Dr. Kostas Tzoumas, Dr. Stephan Ewen > >>>> > >> > >> -- > >> > >> Konstantin Knauf | Solutions Architect > >> > >> +49 160 91394525 > >> > >> > >> Planned Absences: 10.08.2019 - 31.08.2019, 05.09. - 06.09.2010 > >> > >> > >> -- > >> > >> Ververica GmbH | Invalidenstrasse 115, 10115 Berlin, Germany > >> > >> -- > >> > >> Ververica GmbH > >> Registered at Amtsgericht Charlottenburg: HRB 158244 B > >> Managing Directors: Dr. Kostas Tzoumas, Dr. Stephan Ewen > >> > >
