You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@beam.apache.org by Michael Luckey <ad...@gmail.com> on 2019/05/16 13:32:15 UTC

learning kata as root project

Hi,

I just learned, that the newly merged learning/kata/java is setup as full
fledged root project [1].

Is this intentional? If so, should we provide some documentation on the
whys?

Re: learning kata as root project

Posted by Henry Suryawirawan <hs...@google.com>.
I can certainly add it to the learning resources.




On Wed, Jun 12, 2019 at 3:44 PM Ismaël Mejía <ie...@gmail.com> wrote:

> Now that this is merged into master and the post is published, maybe
> we should make it more visible in the website. Maybe add it in
> https://beam.apache.org/documentation/resources/learning-resources/
> and fix navigation to make it more visible too. Volunteers?
>
> On Sat, May 25, 2019 at 1:10 AM Kenneth Knowles <ke...@apache.org> wrote:
> >
> > Agree that "just import learnings/kata/java" sounds right. Is there any
> build that checks the content so that changes in Beam do not break it?
> >
> > Kenn
> >
> > On Fri, May 17, 2019 at 2:19 AM Michael Luckey <ad...@gmail.com>
> wrote:
> >>
> >> Hi Henry,
> >>
> >> unfortunately I do not know how to give advice here. I would first need
> to better understand the semantics.
> >>
> >> What I recommend we should do, is to add some documentation first.  As
> starting point, we might just copy some of the info given on the PR [1]. I
> d say, those are worth to be added to that subproject readme. We need to
> ensure that some dev knows what to do with this module.
> >>
> >> Regarding the inclusion of Gradle wrapper et all. there might be
> technical reasons to do so. So I would expect, that with the current setup
> I am able to just import that learnings/kata/java into my IDE and it just
> works. That seems to be not the case. Maybe I did something wrong here.
> >>
> >> So I am wondering, how to actually use this structure. If we need to
> add some build step and/or some course.json we probably need to improve
> here also?
> >>
> >> Maybe the coming blog post will answer my questions.
> >>
> >> Best,
> >>
> >> michel
> >>
> >> [1] https://github.com/apache/beam/pull/8358
> >>
> >> On Thu, May 16, 2019 at 5:11 PM Henry Suryawirawan <
> hsuryawirawan@google.com> wrote:
> >>>
> >>> Hi Michael,
> >>>
> >>> I initially started the Kata as a standalone project, which I then
> contributed as-is to the repository.
> >>> Please advise me if there is any guideline on how to set it up better.
> >>>
> >>> One note from me is that due to the way how JetBrains Education work,
> the project might only work if it is loaded as a root project.
> >>> It also has a corresponding .idea/study_project.xml that needs to
> exist for the metadata so that it can load properly.
> >>>
> >>>
> >>>
> >>>
> >>> From: Michael Luckey <ad...@gmail.com>
> >>> Date: Thu, May 16, 2019 at 9:34 PM
> >>> To: dev
> >>>
> >>>> Sorry, missed the link [1]
> >>>>
> >>>> [1] https://github.com/apache/beam/tree/master/learning/katas/java
> >>>>
> >>>>
> >>>>
> >>>> On Thu, May 16, 2019 at 3:32 PM Michael Luckey <ad...@gmail.com>
> wrote:
> >>>>>
> >>>>> Hi,
> >>>>>
> >>>>> I just learned, that the newly merged learning/kata/java is setup as
> full fledged root project [1].
> >>>>>
> >>>>> Is this intentional? If so, should we provide some documentation on
> the whys?
>

Re: learning kata as root project

Posted by Ismaël Mejía <ie...@gmail.com>.
Now that this is merged into master and the post is published, maybe
we should make it more visible in the website. Maybe add it in
https://beam.apache.org/documentation/resources/learning-resources/
and fix navigation to make it more visible too. Volunteers?

On Sat, May 25, 2019 at 1:10 AM Kenneth Knowles <ke...@apache.org> wrote:
>
> Agree that "just import learnings/kata/java" sounds right. Is there any build that checks the content so that changes in Beam do not break it?
>
> Kenn
>
> On Fri, May 17, 2019 at 2:19 AM Michael Luckey <ad...@gmail.com> wrote:
>>
>> Hi Henry,
>>
>> unfortunately I do not know how to give advice here. I would first need to better understand the semantics.
>>
>> What I recommend we should do, is to add some documentation first.  As starting point, we might just copy some of the info given on the PR [1]. I d say, those are worth to be added to that subproject readme. We need to ensure that some dev knows what to do with this module.
>>
>> Regarding the inclusion of Gradle wrapper et all. there might be technical reasons to do so. So I would expect, that with the current setup I am able to just import that learnings/kata/java into my IDE and it just works. That seems to be not the case. Maybe I did something wrong here.
>>
>> So I am wondering, how to actually use this structure. If we need to add some build step and/or some course.json we probably need to improve here also?
>>
>> Maybe the coming blog post will answer my questions.
>>
>> Best,
>>
>> michel
>>
>> [1] https://github.com/apache/beam/pull/8358
>>
>> On Thu, May 16, 2019 at 5:11 PM Henry Suryawirawan <hs...@google.com> wrote:
>>>
>>> Hi Michael,
>>>
>>> I initially started the Kata as a standalone project, which I then contributed as-is to the repository.
>>> Please advise me if there is any guideline on how to set it up better.
>>>
>>> One note from me is that due to the way how JetBrains Education work, the project might only work if it is loaded as a root project.
>>> It also has a corresponding .idea/study_project.xml that needs to exist for the metadata so that it can load properly.
>>>
>>>
>>>
>>>
>>> From: Michael Luckey <ad...@gmail.com>
>>> Date: Thu, May 16, 2019 at 9:34 PM
>>> To: dev
>>>
>>>> Sorry, missed the link [1]
>>>>
>>>> [1] https://github.com/apache/beam/tree/master/learning/katas/java
>>>>
>>>>
>>>>
>>>> On Thu, May 16, 2019 at 3:32 PM Michael Luckey <ad...@gmail.com> wrote:
>>>>>
>>>>> Hi,
>>>>>
>>>>> I just learned, that the newly merged learning/kata/java is setup as full fledged root project [1].
>>>>>
>>>>> Is this intentional? If so, should we provide some documentation on the whys?

Re: learning kata as root project

Posted by Henry Suryawirawan <hs...@google.com>.
Agree that it should work just by importing the kata project.
I will add the README to outline the steps required to import it properly.

As for the build, we can incorporate the Java Katas as part of the Gradle
build.
However, for Python Katas at the moment it can only be done manually
through the IDE until this issue[1] is resolved.

[1] https://youtrack.jetbrains.com/issue/EDU-2149




On Sat, May 25, 2019 at 7:10 AM Kenneth Knowles <ke...@apache.org> wrote:

> Agree that "just import learnings/kata/java" sounds right. Is there any
> build that checks the content so that changes in Beam do not break it?
>
> Kenn
>
> On Fri, May 17, 2019 at 2:19 AM Michael Luckey <ad...@gmail.com>
> wrote:
>
>> Hi Henry,
>>
>> unfortunately I do not know how to give advice here. I would first need
>> to better understand the semantics.
>>
>> What I recommend we should do, is to add some documentation first.  As
>> starting point, we might just copy some of the info given on the PR [1]. I
>> d say, those are worth to be added to that subproject readme. We need to
>> ensure that some dev knows what to do with this module.
>>
>> Regarding the inclusion of Gradle wrapper et all. there might be
>> technical reasons to do so. So I would expect, that with the current setup
>> I am able to just import that learnings/kata/java into my IDE and it just
>> works. That seems to be not the case. Maybe I did something wrong here.
>>
>> So I am wondering, how to actually use this structure. If we need to add
>> some build step and/or some course.json we probably need to improve here
>> also?
>>
>> Maybe the coming blog post will answer my questions.
>>
>> Best,
>>
>> michel
>>
>> [1] https://github.com/apache/beam/pull/8358
>>
>> On Thu, May 16, 2019 at 5:11 PM Henry Suryawirawan <
>> hsuryawirawan@google.com> wrote:
>>
>>> Hi Michael,
>>>
>>> I initially started the Kata as a standalone project, which I then
>>> contributed as-is to the repository.
>>> Please advise me if there is any guideline on how to set it up better.
>>>
>>> One note from me is that due to the way how JetBrains Education work,
>>> the project might only work if it is loaded as a root project.
>>> It also has a corresponding .idea/study_project.xml that needs to exist
>>> for the metadata so that it can load properly.
>>>
>>>
>>>
>>>
>>> *From: *Michael Luckey <ad...@gmail.com>
>>> *Date: *Thu, May 16, 2019 at 9:34 PM
>>> *To: *dev
>>>
>>> Sorry, missed the link [1]
>>>>
>>>> [1] https://github.com/apache/beam/tree/master/learning/katas/java
>>>>
>>>>
>>>>
>>>> On Thu, May 16, 2019 at 3:32 PM Michael Luckey <ad...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hi,
>>>>>
>>>>> I just learned, that the newly merged learning/kata/java is setup as
>>>>> full fledged root project [1].
>>>>>
>>>>> Is this intentional? If so, should we provide some documentation on
>>>>> the whys?
>>>>>
>>>>

Re: learning kata as root project

Posted by Kenneth Knowles <ke...@apache.org>.
Agree that "just import learnings/kata/java" sounds right. Is there any
build that checks the content so that changes in Beam do not break it?

Kenn

On Fri, May 17, 2019 at 2:19 AM Michael Luckey <ad...@gmail.com> wrote:

> Hi Henry,
>
> unfortunately I do not know how to give advice here. I would first need to
> better understand the semantics.
>
> What I recommend we should do, is to add some documentation first.  As
> starting point, we might just copy some of the info given on the PR [1]. I
> d say, those are worth to be added to that subproject readme. We need to
> ensure that some dev knows what to do with this module.
>
> Regarding the inclusion of Gradle wrapper et all. there might be technical
> reasons to do so. So I would expect, that with the current setup I am able
> to just import that learnings/kata/java into my IDE and it just works. That
> seems to be not the case. Maybe I did something wrong here.
>
> So I am wondering, how to actually use this structure. If we need to add
> some build step and/or some course.json we probably need to improve here
> also?
>
> Maybe the coming blog post will answer my questions.
>
> Best,
>
> michel
>
> [1] https://github.com/apache/beam/pull/8358
>
> On Thu, May 16, 2019 at 5:11 PM Henry Suryawirawan <
> hsuryawirawan@google.com> wrote:
>
>> Hi Michael,
>>
>> I initially started the Kata as a standalone project, which I then
>> contributed as-is to the repository.
>> Please advise me if there is any guideline on how to set it up better.
>>
>> One note from me is that due to the way how JetBrains Education work, the
>> project might only work if it is loaded as a root project.
>> It also has a corresponding .idea/study_project.xml that needs to exist
>> for the metadata so that it can load properly.
>>
>>
>>
>>
>> *From: *Michael Luckey <ad...@gmail.com>
>> *Date: *Thu, May 16, 2019 at 9:34 PM
>> *To: *dev
>>
>> Sorry, missed the link [1]
>>>
>>> [1] https://github.com/apache/beam/tree/master/learning/katas/java
>>>
>>>
>>>
>>> On Thu, May 16, 2019 at 3:32 PM Michael Luckey <ad...@gmail.com>
>>> wrote:
>>>
>>>> Hi,
>>>>
>>>> I just learned, that the newly merged learning/kata/java is setup as
>>>> full fledged root project [1].
>>>>
>>>> Is this intentional? If so, should we provide some documentation on the
>>>> whys?
>>>>
>>>

Re: learning kata as root project

Posted by Michael Luckey <ad...@gmail.com>.
Hi Henry,

unfortunately I do not know how to give advice here. I would first need to
better understand the semantics.

What I recommend we should do, is to add some documentation first.  As
starting point, we might just copy some of the info given on the PR [1]. I
d say, those are worth to be added to that subproject readme. We need to
ensure that some dev knows what to do with this module.

Regarding the inclusion of Gradle wrapper et all. there might be technical
reasons to do so. So I would expect, that with the current setup I am able
to just import that learnings/kata/java into my IDE and it just works. That
seems to be not the case. Maybe I did something wrong here.

So I am wondering, how to actually use this structure. If we need to add
some build step and/or some course.json we probably need to improve here
also?

Maybe the coming blog post will answer my questions.

Best,

michel

[1] https://github.com/apache/beam/pull/8358

On Thu, May 16, 2019 at 5:11 PM Henry Suryawirawan <hs...@google.com>
wrote:

> Hi Michael,
>
> I initially started the Kata as a standalone project, which I then
> contributed as-is to the repository.
> Please advise me if there is any guideline on how to set it up better.
>
> One note from me is that due to the way how JetBrains Education work, the
> project might only work if it is loaded as a root project.
> It also has a corresponding .idea/study_project.xml that needs to exist
> for the metadata so that it can load properly.
>
>
>
>
> *From: *Michael Luckey <ad...@gmail.com>
> *Date: *Thu, May 16, 2019 at 9:34 PM
> *To: *dev
>
> Sorry, missed the link [1]
>>
>> [1] https://github.com/apache/beam/tree/master/learning/katas/java
>>
>>
>>
>> On Thu, May 16, 2019 at 3:32 PM Michael Luckey <ad...@gmail.com>
>> wrote:
>>
>>> Hi,
>>>
>>> I just learned, that the newly merged learning/kata/java is setup as
>>> full fledged root project [1].
>>>
>>> Is this intentional? If so, should we provide some documentation on the
>>> whys?
>>>
>>

Re: learning kata as root project

Posted by Henry Suryawirawan <hs...@google.com>.
Hi Michael,

I initially started the Kata as a standalone project, which I then
contributed as-is to the repository.
Please advise me if there is any guideline on how to set it up better.

One note from me is that due to the way how JetBrains Education work, the
project might only work if it is loaded as a root project.
It also has a corresponding .idea/study_project.xml that needs to exist for
the metadata so that it can load properly.




*From: *Michael Luckey <ad...@gmail.com>
*Date: *Thu, May 16, 2019 at 9:34 PM
*To: *dev

Sorry, missed the link [1]
>
> [1] https://github.com/apache/beam/tree/master/learning/katas/java
>
>
>
> On Thu, May 16, 2019 at 3:32 PM Michael Luckey <ad...@gmail.com>
> wrote:
>
>> Hi,
>>
>> I just learned, that the newly merged learning/kata/java is setup as full
>> fledged root project [1].
>>
>> Is this intentional? If so, should we provide some documentation on the
>> whys?
>>
>

Re: learning kata as root project

Posted by Michael Luckey <ad...@gmail.com>.
Sorry, missed the link [1]

[1] https://github.com/apache/beam/tree/master/learning/katas/java



On Thu, May 16, 2019 at 3:32 PM Michael Luckey <ad...@gmail.com> wrote:

> Hi,
>
> I just learned, that the newly merged learning/kata/java is setup as full
> fledged root project [1].
>
> Is this intentional? If so, should we provide some documentation on the
> whys?
>