Dear Wiki user, You have subscribed to a wiki page or wiki category on "Hadoop Wiki" for change notification.
The "Chukwa_How_To_Contribute" page has been changed by EricYang: http://wiki.apache.org/hadoop/Chukwa_How_To_Contribute?action=diff&rev1=3&rev2=4 <<Anchor(Documentation)>> ==== Committing Documentation ==== - Chukwa's official documentation is authored using [[http://forrest.apache.org/|Forrest]]. To commit documentation changes you must have Forrest installed and the {{{forrest}}} executable on your {{{$PATH}}}. Note that the current version (0.8) doesn't work properly with Java 6, use Java 5 instead. Documentation is of two types: + Chukwa's official documentation is authored using Maven APT format. To commit documentation changes you must have Maven installed and the {{{mvn}}} executable on your {{{$PATH}}}. Documentation is of two types: 1. End-user documentation, versioned with releases; and, 1. The website. This is maintained separately in subversion, republished as it is changed. - To commit end-user documentation changes to trunk or a branch, ask the user to submit only changes made to the *.xml files in {{{src/docs}}}. Apply that patch, run {{{ant docs}}} to generate the html, and then commit. End-user documentation is only published to the web when releases are made, as described in HowToRelease. + To commit end-user documentation changes to trunk or a branch, ask the user to submit only changes made to the *.apt files in {{{src/docs}}}. Apply that patch, run {{{mvn site}}} to generate the html, and then {{{mvn site-deploy}} to publish. End-user documentation is only published to the web when releases are made, as described in HowToRelease. To commit changes to the website and re-publish them: {{{ svn co https://svn.apache.org/repos/asf/incubator/chukwa/site cd site - ant + mvn site - firefox publish/index.html # preview the changes + firefox target/index.html # preview the changes svn stat # check for new pages svn add # add any new pages svn commit + mvn site-deploy - ssh people.apache.org - cd /www/incubator.apache.org/chukwa - svn up }}} - Changes to website (''via svn up'') might take upto an hour to be reflected on Chukwa site. + Changes to website (''via mvn site-deploy'') might take upto an hour to be reflected on Chukwa site. == Backporting commits to previous branches ==
