Thanks Devin I will take a look. Another missing documentation we need (and I suppose it will come with the first release) is a website for the current SDK javadoc. Are the javadocs already published in some public place (beam.apache.org or people.apache, etc.) ? or what is the current plan ?
On Sat, May 28, 2016 at 2:20 AM, Devin Donnelly < [email protected]> wrote: > The relevant file you're looking for, and the one that's constantly > updated, is: > > /docs/programming-guide.md > > On Fri, May 27, 2016 at 5:20 PM, Devin Donnelly <[email protected]> > wrote: > > > Here's the URL of my fork, so you can see what it looks like so far: > > > > https://github.com/devin-donnelly/incubator-beam-site/tree/beam-pg > > > > On Mon, May 23, 2016 at 8:02 AM, Jean-Baptiste Onofré <[email protected]> > > wrote: > > > >> Agree, it would be great to have such user guide + a started guide for > >> Beam. > >> > >> Regards > >> JB > >> > >> > >> On 05/23/2016 04:41 PM, Jesse Anderson wrote: > >> > >>> I think Josh's Crunch User Guide is a great example of what a user > guide > >>> should cover. https://crunch.apache.org/user-guide.html > >>> > >>> On Mon, May 23, 2016 at 2:00 AM Ismaël Mejía <[email protected]> > wrote: > >>> > >>> Ok, I agree Davor for end users a getting started guide is not only > >>>> important but I would say critical at this moment, the FAQ can be an > >>>> effort > >>>> run in parallel. The project is incubating so the FAQ would be in its > >>>> early > >>>> state, and ideally we must not need an enormous FAQ, however this > >>>> project > >>>> mixes many different technologies, and I can easily imagine frequent > >>>> questions about technical details on Sources, Sinks, and Runners e.g. > my > >>>> question on how to reuse the context on the spark runner is a good > >>>> example, > >>>> it is not general enough to put it as a default in the runner, it is > not > >>>> simple enough for a getting started guide, but a good amount of users > >>>> will > >>>> have to deal with it once they write tests for their pipelines. > >>>> > >>>> Devin, thanks for writing, I am interested in the draft, can you > please > >>>> share the URL of your fork, so other people can eventually take a > >>>> look/contribute. > >>>> > >>>> Ismael > >>>> > >>>> > >>>> > >>>> On Fri, May 20, 2016 at 7:35 PM, Devin Donnelly < > >>>> [email protected]> wrote: > >>>> > >>>> FYI: User documentation draft (the Beam Programming Guide) is well > >>>>> underway. I'm regularly pushing stuff out to a fork of the Beam > website > >>>>> repo if anyone wants a sneak peek. > >>>>> On May 20, 2016 9:37 AM, "Davor Bonaci" <[email protected]> > >>>>> > >>>> wrote: > >>>> > >>>>> > >>>>> We are missing a basic getting started guide along with the rest of > >>>>>> > >>>>> user > >>>> > >>>>> documentation. I think we should work on this first. > >>>>>> > >>>>>> FAQ is a great idea for things that aren't or cannot be covered by > >>>>>> > >>>>> those > >>>> > >>>>> documents -- but, we cannot really start that before we have at > least a > >>>>>> draft version of the previous. > >>>>>> > >>>>>> Wiki hosting would be owned by Infra, if we choose to go down that > >>>>>> path > >>>>>> > >>>>> at > >>>>> > >>>>>> some point. > >>>>>> > >>>>>> On Fri, May 20, 2016 at 1:34 AM, Jean-Baptiste Onofré < > >>>>>> [email protected] > >>>>>> > >>>>> > >>>>> wrote: > >>>>>> > >>>>>> Hi, > >>>>>>> > >>>>>>> good idea for the FAQ. Not sure for the wiki: it would prefer kind > of > >>>>>>> governance and review using the website. > >>>>>>> > >>>>>>> Regards > >>>>>>> JB > >>>>>>> > >>>>>>> > >>>>>>> On 05/20/2016 09:24 AM, Ismaël Mejía wrote: > >>>>>>> > >>>>>>> Hello, > >>>>>>>> > >>>>>>>> I have stumbled with some issues while trying to execute pipelines > >>>>>>>> > >>>>>>> with > >>>>> > >>>>>> all > >>>>>>>> the > >>>>>>>> different runners and I was wondering if we need to create a > >>>>>>>> > >>>>>>> Frequently > >>>>> > >>>>>> Asked > >>>>>>>> Questions (FAQ) section on the website. Maybe it would be better > to > >>>>>>>> > >>>>>>> create > >>>>>> > >>>>>>> such > >>>>>>>> thing as a wiki so we can contribute faster. > >>>>>>>> > >>>>>>>> What do you think ? And what way you think is the better to do so > >>>>>>>> > >>>>>>> (infra) > >>>>>> > >>>>>>> ? > >>>>>>>> > >>>>>>>> Regards, > >>>>>>>> Ismaël > >>>>>>>> > >>>>>>>> > >>>>>>>> -- > >>>>>>> Jean-Baptiste Onofré > >>>>>>> [email protected] > >>>>>>> http://blog.nanthrax.net > >>>>>>> Talend - http://www.talend.com > >>>>>>> > >>>>>>> > >>>>>> > >>>>> > >>>> > >>> > >> -- > >> Jean-Baptiste Onofré > >> [email protected] > >> http://blog.nanthrax.net > >> Talend - http://www.talend.com > >> > > > > >
