[
https://issues.apache.org/jira/browse/HDFS-1961?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13037075#comment-13037075
]
Rick Kazman commented on HDFS-1961:
-----------------------------------
Todd,
I'm a researcher. My interest is to understand what the impact of
architectural documentation is on a large, distributed project--who uses it,
does it change how people interact and communicate, does it improve product
quality over time (since there is a shared representation of design intent),
does it make it easier to recruit new contributors or have contributors "grow"
into committers, etc.
I am sincere in my intent to create the best possible architectural
documentation but eventually, if it is to be useful, the HDFS community needs
to "own" this.
Currently, in addition to posting the Word version to Jira, I put a link to the
HTML version of the architecture documentation at the bottom of the "Related
Resources" section of the wiki at http://wiki.apache.org/hadoop/
What do you recommend? Of course, we can do one thing in the short term and
another in the long term, but in the end the community needs to maintain this
document, not me.
> 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
