ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Denis Magda <dma...@gridgain.com>
Subject Re: Providing an example as part of contribution
Date Wed, 30 Dec 2015 10:17:23 GMT
Added additional points regarding optional examples and documentation to 
the to-do list of contributors and to the check-list of reviewers.

--
Denis

On 12/29/2015 9:00 PM, Dmitriy Setrakyan wrote:
> Agree that every new feature should have documentation.
>
> As far as OSGI, Raul did create the documentation on readme:
>
> https://apacheignite.readme.io/docs/osgi-installation-in-karaf
> https://apacheignite.readme.io/docs/osgi-supported-modules
> https://apacheignite.readme.io/docs/osgi-starting-inside-a-container
>
> D.
>
> On Tue, Dec 29, 2015 at 6:00 AM, Sergey Kozlov <skozlov@gridgain.com> wrote:
>
>> I do not mean that adding an example should be the mandatory rule for every
>> new feature but only if make sense (e.g. new package in org.apache.ignite.*
>> introduced).
>> Moreover from my standpoint every new feature should properly presented on
>> readme.io as well. It will reduce time which we (and the community) are
>> spending to explain how the product works.
>>
>> On Tue, Dec 29, 2015 at 4:54 PM, Denis Magda <dmagda@gridgain.com> wrote:
>>
>>> Agree with Sergey, such a rule should be added to the to-do list of a
>>> contributor and to the check-list of reviewers.
>>> However, this must be an optional rule cause it's obvious that there is
>> no
>>> sense to provide an example for every kind of functionality.
>>>
>>> In regards to OSGi I would add both an example and user friendly
>>> documentation on readme.io cause even for members of the community is
>> not
>>> 100% clear what current OSGi integration supports and for which use cases
>>> it should be considered.
>>> @Raul, do you have any plans on this?
>>>
>>> --
>>> Denis
>>>
>>>
>>> On 12/29/2015 4:46 PM, Anton Vinogradov wrote:
>>>
>>>> This should be at least discussable for each new feature/functionalitiy.
>>>> It would be nice to see OSGi example at this release. It's still riddle
>>>> for
>>>> me what our OSGi modules do.
>>>>
>>>> On Tue, Dec 29, 2015 at 4:41 PM, Yakov Zhdanov <yzhdanov@apache.org>
>>>> wrote:
>>>>
>>>> I suggest no rules here. Let's take the decision on whether to add
>> example
>>>>> or not relying on what functionality is being added.
>>>>>
>>>>> --Yakov
>>>>>
>>>>> 2015-12-29 16:21 GMT+03:00 Sergey Kozlov <skozlov@gridgain.com>:
>>>>>
>>>>> Hi
>>>>>> https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute
>>>>>>
>>>>>> I propose to introduce the requirement to add an example for new
>>>>>> features/functionalities. It will make easier further using/testing
by
>>>>>>
>>>>> the
>>>>>
>>>>>> community and may be for review process as well.
>>>>>>
>>>>>> --
>>>>>> Sergey Kozlov
>>>>>>
>>>>>>
>>
>> --
>> Sergey Kozlov
>> GridGain Systems
>> www.gridgain.com
>>


Mime
View raw message