All is well, PlantUML has an Apache Licensed distribution as well, AND
the diagrams are explicitly not covered by a license:
http://plantuml.com/faq

The UML diagrams in Beam Fn API doc are almost certainly PlantUML !

On Thu, Oct 17, 2019 at 4:07 PM Ismaël Mejía <[email protected]> wrote:
>
> In previous documents they have used a textual representation for UML
> that renders quite nice looking diagrams, see for example the UML
> diagram in this doc:
> https://s.apache.org/beam-fn-api-processing-a-bundle
>
> I think that they use a tool (StartUML?) for that. In any case even if
> the tool used to produce the diagram is GPL licensed the resulting
> diagram is not so that should not be a problem.
>
> On Thu, Oct 17, 2019 at 3:39 PM Etienne Chauchot <[email protected]> wrote:
> >
> > Yes maybe convert to PlantUML as the diagram was done with a commercial 
> > tool for rapidity reasons.
> >
> > ouch plantUML is GPL which is incompatible with Apachev2 license. But can 
> > we still embed docs that were done with that tool?
> >
> > Etienne
> >
> >
> > On 16/10/2019 20:01, Valentyn Tymofieiev wrote:
> >
> > It may be useful to have the UML  source available & linked as well to make 
> > it possible to maintain these charts going forward.
> >
> > On Wed, Oct 16, 2019 at 10:36 AM Pablo Estrada <[email protected]> wrote:
> >>
> >> Maybe add a link to it from Javadocs as well? So source implementers / 
> >> users may have an idea of how these things work generally? : )
> >>
> >> On Wed, Oct 16, 2019 at 1:15 AM Etienne Chauchot <[email protected]> 
> >> wrote:
> >>>
> >>> Hi Kenn,
> >>>
> >>> Thanks for the comment. I agree, current representation is unclear. I'll 
> >>> find a way to keep both sequence diagram shape and represent nested loops 
> >>> and submit a PR on the website.
> >>>
> >>> Etienne
> >>>
> >>> On 15/10/2019 18:04, Kenneth Knowles wrote:
> >>>
> >>> Content seems useful illustration. I think for DoFn I would clarify:
> >>>
> >>> Currently for DoFn:
> >>>
> >>> > For each bundle: call startBundle
> >>> > For each element: call processElement
> >>>
> >>> But this makes it seem like these are two loops, one completed before the 
> >>> other. And it makes it not quite so clear that start/process/finish 
> >>> bundle happens many times during setup/teardown lifecycle. Maybe try 
> >>> other ways to illustrate the pattern, which (is (Setup (StartBundle 
> >>> (ProcessElement|OnTimer)* FinishBundle)* Teardown?) and emphasize that a 
> >>> DoFn instance is never used in parallel.
> >>>
> >>> Kenn
> >>>
> >>>
> >>> On Tue, Oct 15, 2019 at 8:49 AM Etienne Chauchot <[email protected]> 
> >>> wrote:
> >>>>
> >>>> Hi all,
> >>>>
> >>>> I did 2 sequence diagrams for internal training purposes, one for 
> >>>> source, the other for DoFn. What do you think about adding them to the 
> >>>> programming guide ?
> >>>>
> >>>> Here they are:
> >>>>
> >>>> Best
> >>>>
> >>>> Etienne

Reply via email to