hadoop-common-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Hadoop Wiki] Update of "HowToCommit" by AkiraAjisaka
Date Thu, 04 Feb 2016 10:18:22 GMT
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 AkiraAjisaka:
https://wiki.apache.org/hadoop/HowToCommit?action=diff&rev1=31&rev2=32

Comment:
Updated how to publish documents.

  <<Anchor(Documentation)>>
  ==== Committing Documentation ====
  
- Hadoop'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 ([[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 [[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:
   1. End-user documentation, versioned with releases; and,
   1. The website.  This is maintained separately in subversion, republished as it is changed.
  
@@ -70, +70 @@

  
  To commit changes to the website and re-publish them: {{{
  svn co https://svn.apache.org/repos/asf/hadoop/common/site
- cd site
- ant
+ cd site/main
+ $FORREST_HOME/tools/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
+ firefox publish/index.html                           # preview the changes
- svn stat                   # check for new pages
+ svn stat                                             # check for new pages
- svn add                    # add any new pages
+ svn add                                              # add any new pages
  svn commit
  ssh people.apache.org
  cd /www/hadoop.apache.org/common

Mime
View raw message