Nutch 2.0 Documentation

[lewis john mcgibbney <le...@gmail.com>]

Hi,

Was mucking around on a totally separate personal issue with Gora today and
couldn't help but like the /docs directory which is bundled when you svn co
the project. I would really like to push to get this going as per [1] as I
have been trying to get various documentation updated over the last while.
This would be a reasonable milestone which would carve the way for a fully
documented Nutch 2.0 (and branch 1.4) ;0)

Would it be possible for me to invoke a small conversation on this topic to
gather thoughts as it seems this issue has been forgotten about again.

Thank you

[1] https://issues.apache.org/jira/browse/NUTCH-881
-- 
*Lewis*

Re: Nutch 2.0 Documentation

[lewis john mcgibbney <le...@gmail.com>]

Hi Markus,

This is correct, in Nutch trunk we currently only have the wiki as a
repository for any Nutch 2.0 information. Is this satisfactory?

As far as I can tell, the documentation for Gora_trunk is produced using
Apache Forrest. I am reasonably familiar with using Forrest and it would be
a great benefit, as well as lessening the burden upon mailing lists, if we
could maintain a clean distribution of documentation bundled nicely into a
/trunk/docs or/and branch-1.4/docs directory from now on and for all future
official releases.

I think the only addition to the documentation we require on the website is
a formal tutorial (available as part of the Apache Nutch website), which we
need to add to /site resources and which we could maintain and direct users
to as a one stop resource for Nutch branch/tags, then similarly a separate
resource for trunk.

ith specific reference to Nutch Trunk, in comparison on the Gora team they
have provided a quick-start guide followed by a more in depth tutorial,
which in our case we could apply to both branch-1.4 and 2.0 trunk. The
quick-start guide would only show users how to get trunk up and running,
then the formal tutorial would provide in-depth documentation on completing
a crawl with either Nutch 1.4 or trunk 2.0. Does this sound reasonable?

Andrzej provided some good comments in the correspondence on NUTCH-881 which
should be addressed within any comprehensive documentation. I am very happy,
and pretty keen to get this issue resolved but I think we need to agree on a
specific tasks which need to be addressed, basically laying the path for
everything this issue encompasses.

I'm going to paste this to the issue itself as it will be easier to track
over time.


On Tue, Aug 9, 2011 at 11:52 AM, Markus Jelsma
<ma...@openindex.io>wrote:

> Hi,
>
> Maybe a stupid question but i don't see a trunk/docs?
>
> Cheers
>
>
> On Thursday 04 August 2011 12:47:54 lewis john mcgibbney wrote:
> > Hi,
> >
> > Was mucking around on a totally separate personal issue with Gora today
> and
> > couldn't help but like the /docs directory which is bundled when you svn
> co
> > the project. I would really like to push to get this going as per [1] as
> I
> > have been trying to get various documentation updated over the last
> while.
> > This would be a reasonable milestone which would carve the way for a
> fully
> > documented Nutch 2.0 (and branch 1.4) ;0)
> >
> > Would it be possible for me to invoke a small conversation on this topic
> to
> > gather thoughts as it seems this issue has been forgotten about again.
> >
> > Thank you
> >
> > [1] https://issues.apache.org/jira/browse/NUTCH-881
>
> --
> Markus Jelsma - CTO - Openindex
> http://www.linkedin.com/in/markus17
> 050-8536620 / 06-50258350
>



-- 
*Lewis*

Re: Nutch 2.0 Documentation

[Markus Jelsma <ma...@openindex.io>]

Hi,

Maybe a stupid question but i don't see a trunk/docs?

Cheers


On Thursday 04 August 2011 12:47:54 lewis john mcgibbney wrote:
> Hi,
> 
> Was mucking around on a totally separate personal issue with Gora today and
> couldn't help but like the /docs directory which is bundled when you svn co
> the project. I would really like to push to get this going as per [1] as I
> have been trying to get various documentation updated over the last while.
> This would be a reasonable milestone which would carve the way for a fully
> documented Nutch 2.0 (and branch 1.4) ;0)
> 
> Would it be possible for me to invoke a small conversation on this topic to
> gather thoughts as it seems this issue has been forgotten about again.
> 
> Thank you
> 
> [1] https://issues.apache.org/jira/browse/NUTCH-881

-- 
Markus Jelsma - CTO - Openindex
http://www.linkedin.com/in/markus17
050-8536620 / 06-50258350