You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nutch.apache.org by Diaa Abdallah <di...@gmail.com> on 2014/04/25 01:01:47 UTC
Contributing Improvements to Classes documentation
Hi,
I am trying to improve the documentation of nutch while I'm going through
its classes.
I do that by creating tasks on jira.
Is that the correct way to go?
Thanks,
Diaa
Re: Contributing Improvements to Classes documentation
Posted by Xavier Morera <xa...@familiamorera.com>.
Hi Diaa,
You are right. I didn't fully understand. I thought it was documentation
for users or devs!
On Thu, Apr 24, 2014 at 5:31 PM, Diaa Abdallah
<di...@gmail.com>wrote:
> Hi Chris,
> Thanks a lot for the motivation :)
> I already tried improving the injector class and filed a Jira ticket for
> it NUTCH-1763
>
> Morea,
> I think you misunderstood. I meant adding comments in the code and
> improving the javadocs not creating a manual for nutch.
>
> Thanks,
> Diaa
>
>
> On Fri, Apr 25, 2014 at 1:25 AM, Xavier Morera <xa...@familiamorera.com>wrote:
>
>> Hi Diaa,
>>
>> Not exactly. Jira is used for project management. You can schedule
>> milestones/versions, track bugs, include new features, and many development
>> related tasks. In fact I published a course on how to manage your project
>> using Agile methodologies with Jira Agile. You can check it out here or if
>> you have punctual questions fire away.
>>
>>
>> http://pluralsight.com/training/Courses/TableOfContents/scrum-development-jira-agile
>>
>> For documentation you can use:
>> - A wiki like the old one in solr, MediaWiki is the one used by
>> Wikipedia. Solr guys old wiki is here:
>> http://wiki.apache.org/solr/FrontPage
>> - Or if you want to do it in a nice way use Confluence which I would
>> believe you also have the license for as Nutch is from Apache. Look at how
>> the Solr guys do it in their new Wiki:
>> https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide
>>
>> What do you think?
>>
>>
>>
>> On Thu, Apr 24, 2014 at 5:01 PM, Diaa Abdallah <
>> diaa.abdelmoneim@gmail.com> wrote:
>>
>>> Hi,
>>> I am trying to improve the documentation of nutch while I'm going
>>> through its classes.
>>> I do that by creating tasks on jira.
>>>
>>> Is that the correct way to go?
>>>
>>> Thanks,
>>> Diaa
>>>
>>
>>
>>
>> --
>> *Xavier Morera*
>> email: xavier@familiamorera.com
>> CR: +(506) 8849 8866
>> US: +1 (305) 600 4919
>> skype: xmorera
>>
>
>
--
*Xavier Morera*
email: xavier@familiamorera.com
CR: +(506) 8849 8866
US: +1 (305) 600 4919
skype: xmorera
Re: Contributing Improvements to Classes documentation
Posted by Diaa Abdallah <di...@gmail.com>.
Hi Chris,
Thanks a lot for the motivation :)
I already tried improving the injector class and filed a Jira ticket for it
NUTCH-1763
Morea,
I think you misunderstood. I meant adding comments in the code and
improving the javadocs not creating a manual for nutch.
Thanks,
Diaa
On Fri, Apr 25, 2014 at 1:25 AM, Xavier Morera <xa...@familiamorera.com>wrote:
> Hi Diaa,
>
> Not exactly. Jira is used for project management. You can schedule
> milestones/versions, track bugs, include new features, and many development
> related tasks. In fact I published a course on how to manage your project
> using Agile methodologies with Jira Agile. You can check it out here or if
> you have punctual questions fire away.
>
>
> http://pluralsight.com/training/Courses/TableOfContents/scrum-development-jira-agile
>
> For documentation you can use:
> - A wiki like the old one in solr, MediaWiki is the one used by Wikipedia.
> Solr guys old wiki is here: http://wiki.apache.org/solr/FrontPage
> - Or if you want to do it in a nice way use Confluence which I would
> believe you also have the license for as Nutch is from Apache. Look at how
> the Solr guys do it in their new Wiki:
> https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide
>
> What do you think?
>
>
>
> On Thu, Apr 24, 2014 at 5:01 PM, Diaa Abdallah <diaa.abdelmoneim@gmail.com
> > wrote:
>
>> Hi,
>> I am trying to improve the documentation of nutch while I'm going through
>> its classes.
>> I do that by creating tasks on jira.
>>
>> Is that the correct way to go?
>>
>> Thanks,
>> Diaa
>>
>
>
>
> --
> *Xavier Morera*
> email: xavier@familiamorera.com
> CR: +(506) 8849 8866
> US: +1 (305) 600 4919
> skype: xmorera
>
Re: Contributing Improvements to Classes documentation
Posted by Xavier Morera <xa...@familiamorera.com>.
Hi Diaa,
Not exactly. Jira is used for project management. You can schedule
milestones/versions, track bugs, include new features, and many development
related tasks. In fact I published a course on how to manage your project
using Agile methodologies with Jira Agile. You can check it out here or if
you have punctual questions fire away.
http://pluralsight.com/training/Courses/TableOfContents/scrum-development-jira-agile
For documentation you can use:
- A wiki like the old one in solr, MediaWiki is the one used by Wikipedia.
Solr guys old wiki is here: http://wiki.apache.org/solr/FrontPage
- Or if you want to do it in a nice way use Confluence which I would
believe you also have the license for as Nutch is from Apache. Look at how
the Solr guys do it in their new Wiki:
https://cwiki.apache.org/confluence/display/solr/Apache+Solr+Reference+Guide
What do you think?
On Thu, Apr 24, 2014 at 5:01 PM, Diaa Abdallah
<di...@gmail.com>wrote:
> Hi,
> I am trying to improve the documentation of nutch while I'm going through
> its classes.
> I do that by creating tasks on jira.
>
> Is that the correct way to go?
>
> Thanks,
> Diaa
>
--
*Xavier Morera*
email: xavier@familiamorera.com
CR: +(506) 8849 8866
US: +1 (305) 600 4919
skype: xmorera
Re: Contributing Improvements to Classes documentation
Posted by Xavier Morera <xa...@familiamorera.com>.
BTW: I was just making a suggestion as a personal opinion. If committers
believe Jira is the way to go then please ignore my recommendation.
I just think Confluence is a very nice, user friendly way to document while
Jira is for development tasks. Good thing is that they work together like a
charm.
On Thu, Apr 24, 2014 at 5:18 PM, Mattmann, Chris A (3980) <
chris.a.mattmann@jpl.nasa.gov> wrote:
> Thanks Diaa. Sure, please file JIRAs and contribute doc patches
> we would sincerely appreciate it and I for one will work to make
> sure they are committed!
>
> Cheers,
> Chris
>
>
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> Chris Mattmann, Ph.D.
> Chief Architect
> Instrument Software and Science Data Systems Section (398)
> NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
> Office: 168-519, Mailstop: 168-5th floor
> Email: chris.a.mattmann@nasa.gov
> WWW: http://sunset.usc.edu/~mattmann/
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> Adjunct Associate Professor, Computer Science Department
> University of Southern California, Los Angeles, CA 90089 USA
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>
>
>
>
>
>
> -----Original Message-----
> From: Diaa Abdallah <di...@gmail.com>
> Reply-To: "dev@nutch.apache.org" <de...@nutch.apache.org>
> Date: Thursday, April 24, 2014 4:01 PM
> To: "dev@nutch.apache.org" <de...@nutch.apache.org>
> Subject: Contributing Improvements to Classes documentation
>
> >Hi,
> >
> >I am trying to improve the documentation of nutch while I'm going through
> >its classes.
> >
> >I do that by creating tasks on jira.
> >
> >Is that the correct way to go?
> >
> >
> >Thanks,
> >Diaa
> >
>
>
--
*Xavier Morera*
email: xavier@familiamorera.com
CR: +(506) 8849 8866
US: +1 (305) 600 4919
skype: xmorera
Re: Contributing Improvements to Classes documentation
Posted by "Mattmann, Chris A (3980)" <ch...@jpl.nasa.gov>.
Thanks Diaa. Sure, please file JIRAs and contribute doc patches
we would sincerely appreciate it and I for one will work to make
sure they are committed!
Cheers,
Chris
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Chief Architect
Instrument Software and Science Data Systems Section (398)
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 168-519, Mailstop: 168-5th floor
Email: chris.a.mattmann@nasa.gov
WWW: http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Associate Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-----Original Message-----
From: Diaa Abdallah <di...@gmail.com>
Reply-To: "dev@nutch.apache.org" <de...@nutch.apache.org>
Date: Thursday, April 24, 2014 4:01 PM
To: "dev@nutch.apache.org" <de...@nutch.apache.org>
Subject: Contributing Improvements to Classes documentation
>Hi,
>
>I am trying to improve the documentation of nutch while I'm going through
>its classes.
>
>I do that by creating tasks on jira.
>
>Is that the correct way to go?
>
>
>Thanks,
>Diaa
>