hadoop-common-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-hadoop Wiki] Update of "HowToCommit" by DougCutting
Date Wed, 12 Dec 2007 18:16:18 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-hadoop Wiki" for change notification.

The following page has been changed by DougCutting:

The comment on the change is:
update doc docs

   1. Include the Jira issue id in the commit message, along with a short description of the
change and the name of the contributor if it is not you.  Be sure to get the issue id right,
as this causes Jira to link to the change in Subversion (use the issue's "All" tab to see
   1. Resolve the issue as fixed, thanking the contributor.  Always set the "Fix Version"
at this point, but please only set a single fix version, the earliest release in which the
change will appear.
- [[Anchor(CommitToWebsite)]]
+ [[Anchor(CommitDocs)]]
- ==== Committing to the Hadoop website ====
+ ==== Committing Documentation ====
- When you are committing any forrest-based documentation to [http://lucene.apache.org/hadoop/
http://lucene.apache.org/hadoop/] ask the user to submit only changes made to the *.xml files
in {{{src/docs}}}. Apply that patch, then run forrest to generate the html files, manually
copy the modified files to {{{docs/}}} and then commit. Now goto {{{/www/lucene.apache.org/hadoop}}}
on people.apache.org and 'svn up'.
- {{{
- cd src/docs
- forrest site
- cd ../..
- cp -pr src/docs/build/site/* docs/
+ 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}}}.  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 changes to the website and re-publish them: {{{
+ svn co https://svn.apache.org/repos/asf/lucene/hadoop/site
+ cd site
+ ant
+ firefox publish/index.html # preview the changes
+ svn stat                   # check for new pages
+ svn add                    # add any new pages
  svn commit
  ssh people.apache.org
  cd /www/lucene.apache.org/hadoop

View raw message