[jira] Commented: (HADOOP-1917) Need configuration guides for Hadoop

["Nigel Daley (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/HADOOP-1917?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12538656 ] 

Nigel Daley commented on HADOOP-1917:
-------------------------------------

Looks good.  quickstart.html comments:


replace <strong> with <code> in a number of places (environment variables, commands, etc)

"framework i.e. perform" -> 

TM after Java only needs to be on the first occurrence.

"preferably from Sun." -> "preferably from Sun, must be installed."

sshd -> <code>sshd</code>

"must be installed to manage" -> "to manage"

"to use Hadoop's scripts to manage" -> "to use the Hadoop scripts that manage"

http://cvs.apache.org/dist/lucene/hadoop/nightly -> http://lucene.zones.apache.org:8080/hudson/job/Hadoop-Nightly/

"Edit the file" -> "In the unpacked release, edit the file"

"display the documentation" -> "display the usage documentation"

"This is useful for debugging, and can be demonstrated as follows:" -> "This is useful for debugging. The following example copies the unpacked <code>conf</code> directory to use as input and then finds and displays every match of the given regular expression.  Output is written to the given <code>output</code> directory.

remove "This will display counts..."

"can be completely run on a single-node in a pseudo-distributed mode:" -> "can also be run on a single-node in a pseudo-distributed mode (each Hadoop daemon runs in a separate Java process):"

"Use the following" -> "In the unpacked release, edit the file

"A new distributed filesystem must be formatted with the following command:" -> "Format a new Hadoop distributed filesystem:"

"The hadoop daemons are started with the following command:" -> "Start the hadoop daemons:"

"Input files are copied into the distributed filesystem as follows:" -> "Copy input files into the distributed filesystem as follows:"

"Output files are copied from the distributed filesystem as follows:" -> "Optionally, you can copy output files from the distributed filesystem as follows:"


> Need configuration guides for Hadoop
> ------------------------------------
>
>                 Key: HADOOP-1917
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1917
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: conf
>    Affects Versions: 0.14.1
>            Reporter: Sameer Paranjpye
>            Assignee: Arun C Murthy
>            Priority: Critical
>             Fix For: 0.16.0
>
>         Attachments: HADOOP-1917_1_20071025.patch
>
>
> We've recently had a spate of questions on the users list regarding features such as rack-awareness, the trash can etc. which are not clearly documented from a user/admins perspective. There is some Javadoc present but most of the "documentation" exists either in JIRA or in the default config files themselves.
> We should generate top down configuration and use guides for map/reduce and HDFS. These should probably be in forest and accessible from the project website (Javadoc isn't always approachable to our non-programmer audience). Committers should look for user documentation before accepting patches.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.