Documentation

General Documentation aimed at users / system administrators

• manual pages
  • from illumos; better-rendered pages would be appreciated
  • zpool zfs zpool-features zdb zstreamdump
• Oracle's ZFS Administration Guide is largely applicable
• slides from a ZFS overview at SNIA 2008
• Seems applicable to most platforms, but maybe getting out-of-date:
  • ZFS Configuration Guide
  • ZFS Best Practices Guide
  • ZFS Evil Tuning Guide

Distribution-Specific User Documentation

FreeBSD

• manual pages: zpool zfs zpool-features zdb zstreamdump
• ZFS page in The FreeBSD Handbook
• FreeBSD ZFS Wiki

Gentoo

• Wiki page
• Richard Yao's Gentoo Installation Notes

Other

• Links to user documentation (distribution)

Do we want this here or should this just be part of the links to other distributions?

Implementation Documentation aimed at developers

• The ZFS On-Disk Format document is a good overview, although sorely out of date
• The source tour describes the various subcomponents in ZFS.
• Blog posts on specific ZFS features
  • snapshots
  • scrub/resilver
  • ZIL (ZFS Intent Log)
  • space maps and block allocation
  • Hot spares
  • Deduplication
  • RAID-Z

• Architectural/high-level documentation about ZFS as a whole
  • We should collaborate on this with a wiki before the launch
  • Might also have a common set of documentation that can be used for all distributions as a starting point and just modified
  • ZFS Send

Matt, George, Chris Siden, and Max are working on writing the architectural/high-level documentation. We probably need to think about the common user documentation.

Repo-Specific Developer Documentation

• Information about how to develop ZFS for the different distributions/pointers to them (e.g., how to build illumos)
  • In particular, documentation about how to test and possibly scripts for building
  • Needs to be written/links provided by reps from those communities