- Add 2014Q1 report on the Handbook ZFS chapter

Submitted by:	Allan Jude <freebsd@allanjude.com>
This commit is contained in:
Gabor Pali 2014-03-25 00:00:19 +00:00
parent 41d58f222b
commit e3e50f9ca5
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=44349

View file

@ -18,7 +18,7 @@
<!-- XXX: Keep the number of entries updated -->
<p>Thanks to all the reporters for the excellent work! This report
contains 1 entry and we hope you enjoy reading it.</p>
contains 2 entries and we hope you enjoy reading it.</p>
<p>The deadline for submissions covering between April and
June 2014 is July 7th, 2014.</p>
@ -30,6 +30,12 @@
<description>Ports</description>
</category>
<category>
<name>doc</name>
<description>Documentation</description>
</category>
<project cat='ports'>
<title>Chromium</title>
@ -89,4 +95,86 @@
you can join testing and submitting patches upstream.</task>
</help>
</project>
<project cat='doc'>
<title>ZFS Chapter of the Handbook</title>
<contact>
<person>
<name>
<given>Allan</given>
<common>Jude</common>
</name>
<email>freebsd@allanjude.com</email>
</person>
<person>
<name>
<given>Benedict</given>
<common>Reuschling</common>
</name>
<email>bcr@FreeBSD.org</email>
</person>
<person>
<name>
<given>Warren</given>
<common>Block</common>
</name>
<email>wblock@FreeBSD.org</email>
</person>
</contact>
<links>
<url href="http://www.allanjude.com/zfs_handbook/zfs.html">Preview ZFS Handbook</url>
<url href="http://www.allanjude.com/talks/AsiaBSDCon_2014_-_WIP_-_ZFS_Handbook.pdf">Slides from AsiaBSDCon 2014</url>
</links>
<body>
<p>ZFS is one of the premier features of &os;. The current
documentation in the Handbook and elsewhere online is severely
lacking. Much of the original documentation from Sun and Oracle
has disappeared, moved, or is about the proprietary version of
ZFS.</p>
<p>New users have many questions about ZFS and yet there exists a
great deal more bad advice about ZFS than proper documentation.
The current ZFS chapter of the &os; Handbook starts off with the
required steps to configure an i386 machine to run ZFS. This is
more likely to scare off a new user than to educate them about
how to properly use ZFS.</p>
<p>At BSDCan&nbsp;2013, the process of writing an entirely new
chapter of the Handbook on ZFS was started. Currently this
chapter consists of approximately 16,000 words covering all
subcommands of the <tt>zpool(8)</tt> and <tt>zfs(8)</tt>
utilities, delegation, tuning and a section devoted to
defintions and explainations of the terms and features of
ZFS.</p>
<p>The remaining section is the FAQ. To help users address the
most common problems they might run into with ZFS. It would be
useful to hear experiences, questions, misconceptions, gotchas,
stumbling blocks and suggestions for the FAQ section from other
users. Also, a use cases section that highlights some of the
cases where ZFS provides advantages over traditional file
systems.</p>
<p>Please send suggestions to the <tt>freebsd-doc</tt> mailing
list.</p>
</body>
<sponsor>ScaleEngine, Inc</sponsor>
<help>
<task>Technical review by Matt Ahrens (co-creator of ZFS).</task>
<task>Improve delegation section.</task>
<task>Improve tuning section, add new sysctls added in
<tt>head</tt>.</task>
<task>Add section on jails and the jailed property.</task>
<task>Add FAQ section.</task>
<task>Add <q>Use Cases</q> section.</task>
<task>General editing and review.</task>
</help>
</project>
</report>