hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Matt Foley (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HDFS-1961) New architectural documentation created
Date Fri, 20 May 2011 21:38:47 GMT

    [ https://issues.apache.org/jira/browse/HDFS-1961?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13037100#comment-13037100

Matt Foley commented on HDFS-1961:

Wouldn't this kind of document go in the Wiki rather than the code base?  I assumed you were
starting it this way to get it into passable shape before posting it on the Wiki.

Is there a "beta" area of the Wiki, for docs that aren't yet ready for prime time?

The Wiki provides history (like version control) and allows comment in the form of edits.
 Not ideal for tracking, but perhaps workable?

Regarding format, the Word doc can of course generate (ugly) HTML.
Some Wikis have a WHYSIWYG editor, and some of them allow MSWord paste-in.
I don't know if ours does - never tried it :-)

> New architectural documentation created
> ---------------------------------------
>                 Key: HDFS-1961
>                 URL: https://issues.apache.org/jira/browse/HDFS-1961
>             Project: Hadoop HDFS
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 0.21.0
>            Reporter: Rick Kazman
>            Assignee: Rick Kazman
>              Labels: architecture, hadoop, newbie
>             Fix For: 0.21.0
>         Attachments: HDFS ArchDoc.Jira.docx, HDFS-1961_ArchDoc.comments.docx
> This material provides an overview of the HDFS architecture and is intended for contributors.
The goal of this document is to provide a guide to the overall structure of the HDFS code
so that contributors can more effectively understand how changes that they are considering
can be made, and the consequences of those changes. The assumption is that the reader has
a basic understanding of HDFS, its purpose, and how it fits into the Hadoop project suite.

> An HTML version of the architectural documentation can be found at:  http://kazman.shidler.hawaii.edu/ArchDoc.html
> All comments and suggestions for improvements are appreciated.

This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

View raw message