|
[
Permlink
| « Hide
]
Nigel Daley added a comment - 12/Sep/08 03:10 PM
This is not a 0.18.1 blocker.
This will be great to have! Thanks!
 . after this patch being applied, there will be a cn subdir under release-0.17.x/src/docs/. To build Chinese docs, 1 follow the README.BUILD in the cn subdir to download the fonts file needed for generating the pdf files, 2 change to release-0.17.x/src/docs/cn, run "forrest" This patch has been tested through ant test-patch, the following are the command line and the output. NOTE that all the 4 '@author' occurrence are in the XSLT files used by fop, where it means the 'author' attribute of an xml node, is a kind of XPath syntax, not the same meaning as it is in the the Java Docs. So I don't think it's a problem, or do you have any good idea to avoid this warning? command line: ant -Dpatch.file=../release-0.17.0/ output: .... [exec] findbugs: BUILD FAILED Total time: 10 minutes 37 seconds made a little modification, now it passes through the test-patch completely.
I tried this and it doesn't build for me. I get:
validate-xdocs: Maybe it is a problem with my locale. What is your locale set to when you run forrest? Which version of forrest were you running? I'm running forrest 0.8. Also, can you please remove the link to alibaba.com? In Hadoop, we like to encourage community ownership of the project and so don't include author tags in our code or documentation. The problem was caused by the <br/> tag before the alibaba.com link paragraph.
I've removed the link to alibaba.com and the tag. Now it passes through the tests ant -Dpatch.file=../ and ant clean test javadoc checkstyle successfully in my dev env where JAVA_HOME=$HOME/dev/jdk1.5.0_16 Please give another try, it should work for you. Latest patch is good for me. +1
But IMO, The linking to each local community is better such as a "related project" category. Related Project Hbase Mahout -- Local Community China Japan Korea -1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12392059/HADOOP-4164.patch against trunk revision 704310. +1 @author. The patch does not contain any @author tags. +1 tests included. The patch appears to include 9 new or modified tests. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 findbugs. The patch does not introduce any new Findbugs warnings. +1 Eclipse classpath. The patch retains Eclipse classpath integrity. -1 core tests. The patch failed core unit tests. +1 contrib tests. The patch passed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/3456/testReport/ This message is automatically generated. This patch is only for hadoop-0.17.x, we have also finished 0.18 translation, and have 0.19 in progress. Once 0.17.x is pushed online, I will be more familiar with this procedure, and can start to make patch for 0.18.
BTW, how many chinese committers have we got? I think they should review this document.
> BTW, how many chinese committers have we got? I think they should review this document.
I would review this in these few days. 謝謝! (Thanks you!) I followed the instructions in README.BUILD and built the Chinese doc successfully.
Question: The patch requires AR PL UMing fonts with Arphic Public License. Is it okay? I checked the license before I chose AR PL UMing fonts. The license says, "You may copy and distribute verbatim copies of this Font in any medium, without restriction, provided that you retain this license file (ARPHICPL.TXT) unaltered in all copies". I think it's just fine the way we use it.
Talked to Hairong and Owen about this. We should do the following:
After talking with Nicholas, we decided to split the task of reviewing the patch. I have finished reviewing the sections "Quickstart", "Cluster Setup", and "HDFS Architecture". One comment that's not related to the Chinese translation is that HDFS Architecture section needs to be updated. It still talks a lot of future features like permissions, rebalanicing, quotas, and periodic checkpoint that have already implemented.
Since I am familiar with the area of Chinese translation of the computer technique documents, I am not sure if the Chinese translation of some computer terminologies like "rack", "cluster", "replica", and "persistence" etc. are standard or not. It would be nice if those are the standard translations. My following comments are related to the accuracy of the understanding. 1. In "Hadoop Quickstart"->purpose: "run examples/simple jobs" should better be "运行示例程序或简单作业"； We always chose the mainland strandard computer terminologies during the translation, I will check it over and try to get a list of them. After all of the reviews have been done I will merge all the sugguestions into the next patch.
With regard to fonts location,
What do you think? I have read Hadoop DFS User Guide, HDFS Permissions Guide and part of Map-Reduce Tutorial (till Job Input). Most of the doc look good. Here are two points I found:
BTW, I think this sentence about fsck is wrong in the English doc.
I think 20mb is ok for now. Let's go ahead and check it in and we can fix it later if someone comes up with a better solution. Nicholas, how did you get relative paths working? I think that is much better than absolute paths.
> Nicholas, how did you get relative paths working?
I had not use relative paths when I built the Chinese doc. I just have replaced all fopfonts path /usr/local/share/fopfonts/... to some other absolute path, so that I didn't need admin access to create a share directory. Tried to find out how to make relative path works for Cocoon. However, the result is negative. It seems that this is a known missing feature. See
We could define a variable and replace it in runtime by a script, i.e.:
BTW, I have uploaded the generated Chinese doc from the current patch to http://people.apache.org/~szetszwo/4164build/site/ We found a workaround to the relative path problem. Since forrest will find all needed files in $FORREST_HOME/main/webapp, we can just copy the fonts related files into the webapp directory before we start to compile, remove them later. Although it's not so good that we must have write permission to $FORREST_HOME/main/webapp directory, it's pretty convenient right now as we wrap all those into an ant target cn-docs.
The new patch also fixed all the translation problems Hairong and Nicholas pointed out couples of days ago, except the "data block" one. We didn't find any other better words for "data block" in Chinese, fortunately, there is only three "trunk" occured in the core docs. hdfs_design.xml: "Thus, an HDFS file is chopped up into 64 MB chunks, and if possible, each chunk will reside on a different Datanode." The patch passed both ant -Dpatch.file=~/dev/ and ant clean test javadoc checkstyle successfully on my dev-box. I'm sorry, but I found that the last patch does not work for ant cn-docs, because 'svn diff' did not have uming.ttc(a binary file) included into the differences by default.
I've created a new patch, which works well for:
Since the original patch is 23M, far larger than 10M, I just 7zipped it to make it below the upload limit. Created HADOOP-4723 for the English doc problems. Will check the new patch soon.
Requiring w permission to $FORREST_HOME/main/webapp sounds a little bit too much. Owen, what do you think? Failed to build
build.xml.patch: this is the fixes for 1. and 2. The ant command should be ant docs -Dforrest.home=$FORREST_HOME -Djava5.home=$JAVA5 Nicholas, I reproduced the problem by changing my locale settings from zh_CN.utf8 to either POSIX or en_US.iso85991.
So, I made a new patch, which will set locale to en_US.utf8 before forrest invoked: <exec dir="${cndocs.src}" executable="${forrest.home}/bin/forrest" failonerror="true">
<env key="JAVA_HOME" value="${java5.home}"/>
<env key="LANG" value="en_US.utf8"/>
</exec>
Now it's okay in three locale settings: zh_CN.utf8, POSIX and en_US.iso85991 on my dev-box, hope it works for you. I have successfully built the latest patch: http://people.apache.org/~szetszwo/4164_20081202/
I was wrong about my previous comment. Since this patch is going to 0.17, we don't need -Djava5.home=$JAVA5 in the ant command. Could you remove the java5.home related stuffs from build.xml, Xuebing? I am sorry about that. So glad that it finally works.
Java5 stuff is removed, please have another try. BUILD SUCCESSFUL: http://people.apache.org/~szetszwo/4164_20081203/
If the workaround We need to make this patch apply to trunk first and maybe 18 and 19. I can't see us making any more 17 releases. Then we can make much smaller patches to update the documentation from 17 to trunk.
I also don't think it is reasonable to force installation of the fonts in the forrest installation. Could we write the path name (inside the hadoop source) to the xml file as part of the build? Does that make sense? Look at how we invoke src/saveVersion from build.xml to generate a file in the build directory that we then compile. The way like what save/saveVersion does sounds great, I will try to work a new patch out based on trunk.
I have all versions of Chinese translations prior to 0.19, should we just publish them at at http://hadoop.apache.org/core/docs/ @Xuebing: If it's not easy to set that up to hadoop.apache.org, let me know and I can help you make it happen on http://hadooper.cn/
The website is hosted by Chinese Academy of Science.
Uploading it to the Apache site is not a problem. Yes, we can include it in http://hadoop.apache.org/core/docs/r0.17.2/
. I'm sorry that this has gone through so many iterations, but clearly this has been a learning experience, since no other translations have been done yet. I think it is very exciting that the Hadoop documentation was translated into Chinese, and I'm looking forward to getting it published. It would be better to host the translation on hadoop.apache.org, so it is clear that it is the official translation. We should treat these translation contributions much like code contributions, as a route to becoming a committer. Once we commit the first version, and then you submit more high-quality patches updating and improving them, then we can add you as a committer to maintain this documentation at hadoop.apache.org as the official version that would be included in Hadoop releases, etc.
@Owen. What would be the next steps to get this published on http://hadoop.apache.org/core/docs/r0.17.2/
? Owen, I've made two patches for 0.17.2 and 0.18.2. As you know, Chinese docs can be made this way:
7z e HADOOP-0.18.2.patch.7z
svn co http://svn.apache.org/repos/asf/hadoop/core/tags/release-0.18.2 release-0.18.2
cd release-0.18.2
patch -p0 < HADOOP-0.18.2.patch
ant docs -Dforrest.home=$FORREST_HOME
then you will see Chinese docs under docs/cn, please get them published, thanks. Doug Cutting, I'm going to make a trunk-based patch, in which the main Chinese docs will be the same as 0.18.2 at first. After that patch have been applied, I can submit patches to make it update to date. Am I right? And which one should I based on, trunk or branch-0.19? Thanks Zheng, I agree that it's better we host them on hadoop.apache.org first, and I believe Owen will publish them soon after seeing those patches. > After that patch have been applied, I can submit patches to make it update to date. Am I right?
Yes, that sounds good. Thanks! HADOOP-r724961.patch.7z is the one for trunk, although it's made from revision 724961, it can be applied to any post revision if there is no modification to build.xml.
Chinese docs in this patch remains as it is in HADOOP-0.18.2.patch for now, updates will be submitted soon. Tried HADOOP-r724961.patch.7z. Need to add <env key="JAVA_HOME" value="${java5.home}"/> in build.xml. Then, build successful with current trunk: http://people.apache.org/~szetszwo/4164_20081210/
I just committed this. Thanks, Xuebing!
What will be the address on hadoop.apache.org for this?
The following files need to be added to the ignore list.
M src/docs/cn/uming.conf M src/docs/cn/src/documentation/sitemap.xmap I just checked it out on people, so it will show up in a couple of hours at:
http://hadoop.apache.org/core/docs/r0.17.2/cn I "cheated" to put these on the site, by checking the docs out of the branch instead of a release. Once we roll 0.18.3, for instance, it will automatically be there. We should add a link from the English docs to the Chinese docs, no? Perhaps an entry in the menu on the left? Or a flag icon somewhere?
Great! Thank all of you. looking forward to the link from the English docs, that would be better for Chinese users.
Integrated in Hadoop-trunk #685 (See http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/685/
). Another two files to ignore. . Add files to ignore. . Chinese translation of the documentation. (Xuebing Yan via omalley) According to
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 |
|
Wish
Resolved
Major
Chinese translation of core docs
