[
https://issues.apache.org/jira/browse/HDFS-1961?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13037060#comment-13037060
]
Todd Lipcon commented on HDFS-1961:
-----------------------------------
Hi Rick. I'm glad to see someone producing the document, but curious what the
intention is. Is this meant to be checked in to the codebase, and is the
expectation that contributors will update it as architecture changes? If so,
the Word/HTML pair is problematic since it can't be version-controlled in
subversion, and many people can't edit it (I don't have a copy of Word).
In terms of tracking who is using the docs, if it's checked in, then you won't
be able to tell that either since most people will access it locally.
Perhaps the best route here is for this to not become part of Hadoop, but just
to live on your site? We could include a link to it from our documentation in
some kind of "Other resources" page, for example.
> 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
