Dear Wiki user, You have subscribed to a wiki page or wiki category on "Hadoop Wiki" for change notification.
The "HowToCommit" page has been changed by MartonElek: https://wiki.apache.org/hadoop/HowToCommit?action=diff&rev1=41&rev2=42 Comment: Update site generation * [[http://www.apache.org/dev/new-committers-guide.html|Apache New Committer Guide]] * [[http://www.apache.org/dev/committers.html|Apache Committer FAQ]] - The first act of a new core committer is typically to add their name to the [[http://hadoop.apache.org/common/credits.html|credits]] page. This requires changing the XML source in http://svn.apache.org/repos/asf/hadoop/common/site/main/author/src/documentation/content/xdocs/who.xml. Once done, update the Hadoop website as described [[#Documentation|here]]. + The first act of a new core committer is typically to add their name to the [[http://hadoop.apache.org/common/credits.html|credits]] page. This requires changing the site source in https://github.com/apache/hadoop-site/blob/asf-site/src/who.md. Once done, update the Hadoop website as described [[#Documentation|here]] (TLDR; don't forget to regenerate the site with hugo, and commit the generated results, too). == Review == @@ -79, +79 @@ <<Anchor(Documentation)>> ==== Committing Documentation ==== - Hadoop's official documentation is authored using [[http://forrest.apache.org/|Forrest]]. To commit documentation changes you must have Apache Forrest installed, and set the forrest directory on your {{{$FORREST_HOME}}}. Note that the current version ([[wget http://archive.apache.org/dist/forrest/0.9/apache-forrest-0.9.tar.gz|0.9]]) work properly with Java 8. Documentation is of two types: + Hadoop's official documentation is authored using [[https://gohugo.io/|hugo]]. To commit documentation changes you must have Hugo installed (single binary available for all the platforms, part of the package repositories, brew/pacman/yum...). 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. + 1. The website. + + The end user documentation is maintained in the main repository (hadoop.git) and the results are committed to the hadoop-site during each release. The website itself is managed in the hadoop-site.git repository (both the source and the rendered form). 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 changes to the website and re-publish them: {{{ - svn co https://svn.apache.org/repos/asf/hadoop/common/site - cd site/main - $FORREST_HOME/tools/ant/bin/ant -Dforrest.home=$FORREST_HOME # Newer version of Ant does not work. Use the Ant bundled with forrest. - firefox publish/index.html # preview the changes - svn stat # check for new pages - svn add # add any new pages - svn commit + + git clone https://gitbox.apache.org/repos/asf/hadoop-site.git -b asf-site + #edit site under ./src + hugo + # add both the ./src and ./content directories (source and rendered version) + git add . + git commit + git push }}} The commit will be reflected on Apache Hadoop site automatically. + + Note: you can check the rendering locally: with 'hugo serve && firefox http://localhost:1313' == Patches that break HDFS, YARN and MapReduce == --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org