[
https://issues.apache.org/jira/browse/HADOOP-1861?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12526193
]
Doug Cutting commented on HADOOP-1861:
--------------------------------------
> How can we structure this documentation so that it is checked into SVN [ ...]
> ?
There are two ways that we normally do this:
- Include it in the javadoc, either as a package.html that ends up on the
package table-of-contents page, or as class documentation. So we could split
configuration documentation among Configuration, JobConf,
DistributedFileSystem, etc. We should probably do this anyway: the javadoc
should serve as reference documentation, and classes that use parameters should
document them.
- Include it in the site. This requires editing xml files in
src/docs/src/documentation/content/xdocs and running 'forrest'. This is a good
place for "user guide"-type documentation. So we should also include overview
configuration documentation here, perhaps with links to the javadoc for
reference details.
Currently the site's "Install and Configure" link points to the top-level
javadoc (overview.html):
http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description
We could simply enhance this page, but I think long-term we might want more
introductory documentation than we can reasonably squeeze onto a single page.
Another advantage of forrest is that it generates printer-friendly PDF.
> Update the "how to configure HDFS" documentation to include new features
> ------------------------------------------------------------------------
>
> Key: HADOOP-1861
> URL: https://issues.apache.org/jira/browse/HADOOP-1861
> Project: Hadoop
> Issue Type: Improvement
> Components: dfs, documentation
> Reporter: dhruba borthakur
>
> There has been lots of cases where HDFS administrators have enquired about
> setup and configuration of HDFS. A recent question asked about configuring
> Datanodes to understand the rack that it belongs to. There is a wiki page
> that is out-of-date:
> http://wiki.apache.org/lucene-hadoop/HowToConfigure
> Some new things that come to mind are:
> 1. rack location for Datanodes.
> 2. Trash configuration
> 3. SecondaryNamenode config parameters
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
