You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-user@hadoop.apache.org by Jagat <ja...@gmail.com> on 2012/05/04 21:21:11 UTC
Need to improve documentation for v 0.23.x ( v 2.x)
Hello All,
As Apache Hadoop community is ready to release the next 2.0 alpha version
of Hadoop , i would like to bring attention towards need to make better
documentation of the tutorials and examples for the same.
Just one short example
See the Single Node Setup tutorials for v
1.x<http://hadoop.apache.org/common/docs/r1.0.2/single_node_setup.html>and
v
0.23<http://hadoop.apache.org/common/docs/r0.23.1/hadoop-yarn/hadoop-yarn-site/SingleCluster.html>,
you can say 0.23 author is in hurry with keeping all things in
assumption that reader knows everything what and where to do.
We should spend some time on documentation , with so many beautiful
features coming it would be great if you guys plan some special hackathon
meetings to improve its documentation , code examples so that people can
understand how to use them effectively.
At present only two people can understand 0.23 , those who wrote the code
and the other one is java compiler who is verifying its code :)
*Tom White , *I request if you are reading this message , please pick-up
your pen again to write Hadoop Definitive Guide edition 4th dedicated to
next release for greater benefit of community.
Thanks
Re: Need to improve documentation for v 0.23.x ( v 2.x)
Posted by Robert Evans <ev...@yahoo-inc.com>.
Yes I am the one that said I would look into releasing the Yahoo documentation. Thanks for reminding me. I have been a bit distracted, by some "restructuring" that has happened recently, but I will get on that.
--Bobby
On 5/8/12 12:30 PM, "Arun C Murthy" <ac...@hortonworks.com> wrote:
Thanks for offering to provide doc-patches Jagat!
On May 7, 2012, at 9:04 AM, Jagat wrote:
> Hello Bobby,
>
> Yes i will file couple of JIRAs and work on them in coming few days to
> write how to setup things , include basics which were very good in old
> documentation, yes there are many good things which we can take up from
> 1.0.2 documentation also.
>
> Few days back Yahoo team was saying that they can donate documentation to
> community which although old can be improved on to include within Apache.
> May be we can get some update on confirmation for permission to use for the
> same.
>
> One of the project which is good in documentation ( wiki ) is Apache Mahout
> we can learn from them , lots of extensible references , presentations ,
> tutorials all at one place at wiki to refer.
>
>
>
> On Mon, May 7, 2012 at 9:19 PM, Robert Evans <ev...@yahoo-inc.com> wrote:
>
>> I agree that better documentation is almost always needed. The problem is
>> in finding the time to really make this happen. If you or anyone else here
>> wants to help out with this effort please feel free to file JIRAs and
>> submit patches to improve the documentation. Even if all the patch is, is
>> a copy/paste of information from the 1.0.2 documentation that is still
>> relevant for 2.0.
>>
>> --Bobby Evans
>>
>> On 5/4/12 2:21 PM, "Jagat" <ja...@gmail.com> wrote:
>>
>> Hello All,
>>
>> As Apache Hadoop community is ready to release the next 2.0 alpha version
>> of Hadoop , i would like to bring attention towards need to make better
>> documentation of the tutorials and examples for the same.
>>
>> Just one short example
>>
>> See the Single Node Setup tutorials for v
>> 1.x<http://hadoop.apache.org/common/docs/r1.0.2/single_node_setup.html>and
>> v
>> 0.23<
>> http://hadoop.apache.org/common/docs/r0.23.1/hadoop-yarn/hadoop-yarn-site/SingleCluster.html
>>> ,
>> you can say 0.23 author is in hurry with keeping all things in
>> assumption that reader knows everything what and where to do.
>>
>> We should spend some time on documentation , with so many beautiful
>> features coming it would be great if you guys plan some special hackathon
>> meetings to improve its documentation , code examples so that people can
>> understand how to use them effectively.
>>
>> At present only two people can understand 0.23 , those who wrote the code
>> and the other one is java compiler who is verifying its code :)
>>
>> *Tom White , *I request if you are reading this message , please pick-up
>> your pen again to write Hadoop Definitive Guide edition 4th dedicated to
>> next release for greater benefit of community.
>>
>> Thanks
>>
>>
--
Arun C. Murthy
Hortonworks Inc.
http://hortonworks.com/
Re: Need to improve documentation for v 0.23.x ( v 2.x)
Posted by Arun C Murthy <ac...@hortonworks.com>.
Thanks for offering to provide doc-patches Jagat!
On May 7, 2012, at 9:04 AM, Jagat wrote:
> Hello Bobby,
>
> Yes i will file couple of JIRAs and work on them in coming few days to
> write how to setup things , include basics which were very good in old
> documentation, yes there are many good things which we can take up from
> 1.0.2 documentation also.
>
> Few days back Yahoo team was saying that they can donate documentation to
> community which although old can be improved on to include within Apache.
> May be we can get some update on confirmation for permission to use for the
> same.
>
> One of the project which is good in documentation ( wiki ) is Apache Mahout
> we can learn from them , lots of extensible references , presentations ,
> tutorials all at one place at wiki to refer.
>
>
>
> On Mon, May 7, 2012 at 9:19 PM, Robert Evans <ev...@yahoo-inc.com> wrote:
>
>> I agree that better documentation is almost always needed. The problem is
>> in finding the time to really make this happen. If you or anyone else here
>> wants to help out with this effort please feel free to file JIRAs and
>> submit patches to improve the documentation. Even if all the patch is, is
>> a copy/paste of information from the 1.0.2 documentation that is still
>> relevant for 2.0.
>>
>> --Bobby Evans
>>
>> On 5/4/12 2:21 PM, "Jagat" <ja...@gmail.com> wrote:
>>
>> Hello All,
>>
>> As Apache Hadoop community is ready to release the next 2.0 alpha version
>> of Hadoop , i would like to bring attention towards need to make better
>> documentation of the tutorials and examples for the same.
>>
>> Just one short example
>>
>> See the Single Node Setup tutorials for v
>> 1.x<http://hadoop.apache.org/common/docs/r1.0.2/single_node_setup.html>and
>> v
>> 0.23<
>> http://hadoop.apache.org/common/docs/r0.23.1/hadoop-yarn/hadoop-yarn-site/SingleCluster.html
>>> ,
>> you can say 0.23 author is in hurry with keeping all things in
>> assumption that reader knows everything what and where to do.
>>
>> We should spend some time on documentation , with so many beautiful
>> features coming it would be great if you guys plan some special hackathon
>> meetings to improve its documentation , code examples so that people can
>> understand how to use them effectively.
>>
>> At present only two people can understand 0.23 , those who wrote the code
>> and the other one is java compiler who is verifying its code :)
>>
>> *Tom White , *I request if you are reading this message , please pick-up
>> your pen again to write Hadoop Definitive Guide edition 4th dedicated to
>> next release for greater benefit of community.
>>
>> Thanks
>>
>>
--
Arun C. Murthy
Hortonworks Inc.
http://hortonworks.com/
Re: Need to improve documentation for v 0.23.x ( v 2.x)
Posted by Jagat <ja...@gmail.com>.
Hello Bobby,
Yes i will file couple of JIRAs and work on them in coming few days to
write how to setup things , include basics which were very good in old
documentation, yes there are many good things which we can take up from
1.0.2 documentation also.
Few days back Yahoo team was saying that they can donate documentation to
community which although old can be improved on to include within Apache.
May be we can get some update on confirmation for permission to use for the
same.
One of the project which is good in documentation ( wiki ) is Apache Mahout
we can learn from them , lots of extensible references , presentations ,
tutorials all at one place at wiki to refer.
On Mon, May 7, 2012 at 9:19 PM, Robert Evans <ev...@yahoo-inc.com> wrote:
> I agree that better documentation is almost always needed. The problem is
> in finding the time to really make this happen. If you or anyone else here
> wants to help out with this effort please feel free to file JIRAs and
> submit patches to improve the documentation. Even if all the patch is, is
> a copy/paste of information from the 1.0.2 documentation that is still
> relevant for 2.0.
>
> --Bobby Evans
>
> On 5/4/12 2:21 PM, "Jagat" <ja...@gmail.com> wrote:
>
> Hello All,
>
> As Apache Hadoop community is ready to release the next 2.0 alpha version
> of Hadoop , i would like to bring attention towards need to make better
> documentation of the tutorials and examples for the same.
>
> Just one short example
>
> See the Single Node Setup tutorials for v
> 1.x<http://hadoop.apache.org/common/docs/r1.0.2/single_node_setup.html>and
> v
> 0.23<
> http://hadoop.apache.org/common/docs/r0.23.1/hadoop-yarn/hadoop-yarn-site/SingleCluster.html
> >,
> you can say 0.23 author is in hurry with keeping all things in
> assumption that reader knows everything what and where to do.
>
> We should spend some time on documentation , with so many beautiful
> features coming it would be great if you guys plan some special hackathon
> meetings to improve its documentation , code examples so that people can
> understand how to use them effectively.
>
> At present only two people can understand 0.23 , those who wrote the code
> and the other one is java compiler who is verifying its code :)
>
> *Tom White , *I request if you are reading this message , please pick-up
> your pen again to write Hadoop Definitive Guide edition 4th dedicated to
> next release for greater benefit of community.
>
> Thanks
>
>
Re: Need to improve documentation for v 0.23.x ( v 2.x)
Posted by Robert Evans <ev...@yahoo-inc.com>.
I agree that better documentation is almost always needed. The problem is in finding the time to really make this happen. If you or anyone else here wants to help out with this effort please feel free to file JIRAs and submit patches to improve the documentation. Even if all the patch is, is a copy/paste of information from the 1.0.2 documentation that is still relevant for 2.0.
--Bobby Evans
On 5/4/12 2:21 PM, "Jagat" <ja...@gmail.com> wrote:
Hello All,
As Apache Hadoop community is ready to release the next 2.0 alpha version
of Hadoop , i would like to bring attention towards need to make better
documentation of the tutorials and examples for the same.
Just one short example
See the Single Node Setup tutorials for v
1.x<http://hadoop.apache.org/common/docs/r1.0.2/single_node_setup.html>and
v
0.23<http://hadoop.apache.org/common/docs/r0.23.1/hadoop-yarn/hadoop-yarn-site/SingleCluster.html>,
you can say 0.23 author is in hurry with keeping all things in
assumption that reader knows everything what and where to do.
We should spend some time on documentation , with so many beautiful
features coming it would be great if you guys plan some special hackathon
meetings to improve its documentation , code examples so that people can
understand how to use them effectively.
At present only two people can understand 0.23 , those who wrote the code
and the other one is java compiler who is verifying its code :)
*Tom White , *I request if you are reading this message , please pick-up
your pen again to write Hadoop Definitive Guide edition 4th dedicated to
next release for greater benefit of community.
Thanks