[jira] Created: (NUTCH-408) Plugin development documentation

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

[jira] Created: (NUTCH-408) Plugin development documentation

ASF GitHub Bot (Jira)
Plugin development documentation
--------------------------------

                 Key: NUTCH-408
                 URL: http://issues.apache.org/jira/browse/NUTCH-408
             Project: Nutch
          Issue Type: Improvement
    Affects Versions: 0.8.1
         Environment: Linux Fedora
            Reporter: nutch.newbie


Documentation is rare! But very vital for extending current (0.9) nutch. Current docs on the wiki for 0.7 plugin development was good but it doesn't apply to 0.9 and new developers who are joining directly 0.9 find the 0.7 documentation not enough. A more practical plugin writing documentation for 0.9 is desired also exposing the plugin principals in practical terms i.e. extension points and libs etc. furthermore it would be good to provide some best practice example i.e.

look for the lib you are planning to use if its already in lib folder and maybe that version of the external lib is good for the plugin dev rather then using another version things like that..

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       
Reply | Threaded
Open this post in threaded view
|

RE: [jira] Created: (NUTCH-408) Plugin development documentation

Armel T. Nene-2
I agree with you that documentation is vital not the just extending the
current version but also for any plugins and patches created. I have been
spending almost two weeks trying to adapt nutch to my project but I spend
more time in reading code and trying to understand what they do before I can
even start to fix problem. Come on guys, documentation is good coding
practice, we can't read your mind to know exactly what you were trying to
achieve by just looking at the implementation code.

This is just a good constructive criticism.

:) Armel

-----Original Message-----
From: nutch.newbie (JIRA) [mailto:[hidden email]]
Sent: 25 November 2006 03:45
To: [hidden email]
Subject: [jira] Created: (NUTCH-408) Plugin development documentation

Plugin development documentation
--------------------------------

                 Key: NUTCH-408
                 URL: http://issues.apache.org/jira/browse/NUTCH-408
             Project: Nutch
          Issue Type: Improvement
    Affects Versions: 0.8.1
         Environment: Linux Fedora
            Reporter: nutch.newbie


Documentation is rare! But very vital for extending current (0.9) nutch.
Current docs on the wiki for 0.7 plugin development was good but it doesn't
apply to 0.9 and new developers who are joining directly 0.9 find the 0.7
documentation not enough. A more practical plugin writing documentation for
0.9 is desired also exposing the plugin principals in practical terms i.e.
extension points and libs etc. furthermore it would be good to provide some
best practice example i.e.

look for the lib you are planning to use if its already in lib folder and
maybe that version of the external lib is good for the plugin dev rather
then using another version things like that..

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       


Reply | Threaded
Open this post in threaded view
|

Re: [jira] Created: (NUTCH-408) Plugin development documentation

Stefan Groschupf
did you erver browse this: http://wiki.media-style.com/display/ 
nutchDocu/Home
Nothing big, but it will give you some ideas, also about plugins.

On 25.11.2006, at 06:32, Armel T. Nene wrote:

> I agree with you that documentation is vital not the just extending  
> the
> current version but also for any plugins and patches created. I  
> have been
> spending almost two weeks trying to adapt nutch to my project but I  
> spend
> more time in reading code and trying to understand what they do  
> before I can
> even start to fix problem. Come on guys, documentation is good coding
> practice, we can't read your mind to know exactly what you were  
> trying to
> achieve by just looking at the implementation code.
>
> This is just a good constructive criticism.
>
> :) Armel
>
> -----Original Message-----
> From: nutch.newbie (JIRA) [mailto:[hidden email]]
> Sent: 25 November 2006 03:45
> To: [hidden email]
> Subject: [jira] Created: (NUTCH-408) Plugin development documentation
>
> Plugin development documentation
> --------------------------------
>
>                  Key: NUTCH-408
>                  URL: http://issues.apache.org/jira/browse/NUTCH-408
>              Project: Nutch
>           Issue Type: Improvement
>     Affects Versions: 0.8.1
>          Environment: Linux Fedora
>             Reporter: nutch.newbie
>
>
> Documentation is rare! But very vital for extending current (0.9)  
> nutch.
> Current docs on the wiki for 0.7 plugin development was good but it  
> doesn't
> apply to 0.9 and new developers who are joining directly 0.9 find  
> the 0.7
> documentation not enough. A more practical plugin writing  
> documentation for
> 0.9 is desired also exposing the plugin principals in practical  
> terms i.e.
> extension points and libs etc. furthermore it would be good to  
> provide some
> best practice example i.e.
>
> look for the lib you are planning to use if its already in lib  
> folder and
> maybe that version of the external lib is good for the plugin dev  
> rather
> then using another version things like that..
>
> --
> This message is automatically generated by JIRA.
> -
> If you think it was sent incorrectly contact one of the  
> administrators:
> http://issues.apache.org/jira/secure/Administrators.jspa
> -
> For more information on JIRA, see: http://www.atlassian.com/ 
> software/jira
>
>
>
>
>

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101tec Inc.
search tech for web 2.1
Menlo Park, California
http://www.101tec.com



Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (NUTCH-408) Plugin development documentation

ASF GitHub Bot (Jira)
In reply to this post by ASF GitHub Bot (Jira)
    [ http://issues.apache.org/jira/browse/NUTCH-408?page=comments#action_12452610 ]
           
nutch.newbie commented on NUTCH-408:
------------------------------------

Yes, I have gone through the media style documentation and it is a good start. and there are also some very good documentation in Nutch wiki. My thinking was to complete-compile existing documentation in a coherent way so that you get the whole picture. So I  would like to give it a shot at writing but I can not do this all by myself as I lack background info plus I haven't wrote any plugin myself so if any of you would like to help me I would like to do this job. Feel free to mail me directly if you are up for it. I will probably ask lot of stupid question but we will have some development documentation at least :=) what you say? anyone up for this?

Regards

> Plugin development documentation
> --------------------------------
>
>                 Key: NUTCH-408
>                 URL: http://issues.apache.org/jira/browse/NUTCH-408
>             Project: Nutch
>          Issue Type: Improvement
>    Affects Versions: 0.8.1
>         Environment: Linux Fedora
>            Reporter: nutch.newbie
>
> Documentation is rare! But very vital for extending current (0.9) nutch. Current docs on the wiki for 0.7 plugin development was good but it doesn't apply to 0.9 and new developers who are joining directly 0.9 find the 0.7 documentation not enough. A more practical plugin writing documentation for 0.9 is desired also exposing the plugin principals in practical terms i.e. extension points and libs etc. furthermore it would be good to provide some best practice example i.e.
> look for the lib you are planning to use if its already in lib folder and maybe that version of the external lib is good for the plugin dev rather then using another version things like that..

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira