Difference between revisions of "Documentation"

From OpenZFS
Jump to navigation Jump to search
Line 5: Line 5:
* The ZFS [http://maczfs.googlecode.com/files/ZFSOnDiskFormat.pdf On-Disk Format] document is a good overview, although sorely out of date
* The ZFS [http://maczfs.googlecode.com/files/ZFSOnDiskFormat.pdf On-Disk Format] document is a good overview, although sorely out of date
* The [http://java.net/projects/solaris-zfs/pages/Sourcetour source tour] describes the various subcomponents in ZFS.
* The [http://java.net/projects/solaris-zfs/pages/Sourcetour source tour] describes the various subcomponents in ZFS.
* [http://www.snia.org/sites/default/files2/sdc_archives/2008_presentations/monday/JeffBonwick-BillMoore_ZFS.pdf slides] from a ZFS overview at SNIA 2008
* Blog posts on specific ZFS features
* Blog posts on specific ZFS features
** [https://blogs.oracle.com/ahrens/entry/is_it_magic snapshots]
** [https://blogs.oracle.com/ahrens/entry/is_it_magic snapshots]

Revision as of 21:48, 15 August 2013

High-Level ZFS Documentation

  • 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

Matt, George, and Chris Siden 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

Distribution-Specific User Documentation

  • Links to user documentation (distribution)

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