hadoop-hdfs-issues mailing list archives

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

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

Rick Kazman commented on HDFS-1961:


Right now I am maintaining a Word version and an HTML version (the HTML version is hosted
at (http://kazman.shidler.hawaii.edu/ArchDoc.html for the moment).  The advantage of the Word
doc is that it makes change tracking and commenting easy and there are already quite a few
comments and changes (proposed by Matt Foley).  The advantage of HTML is that it makes publishing
and tracking easy.  As part of my research I need to track who is using the documentation,
how, and how often.

But having two versions of course creates a version control issue for me, since I need to
manually keep the two versions consistent--not good.  I am happy to try Forrest (and do whatever
makes most sense for the project) but I haven't used it before.  Suggestions?

> 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