Difference between revisions of "Documentation"
Jump to navigation
Jump to search
| Line 5: | Line 5: | ||
* Oracle's ZFS [http://docs.oracle.com/cd/E26505_01/html/E37384/index.html Administration Guide] is largely applicable | * Oracle's ZFS [http://docs.oracle.com/cd/E26505_01/html/E37384/index.html Administration Guide] is largely applicable | ||
* [http://www.snia.org/sites/default/files2/sdc_archives/2008_presentations/monday/JeffBonwick-BillMoore_ZFS.pdf slides] from a ZFS overview at SNIA 2008 | * [http://www.snia.org/sites/default/files2/sdc_archives/2008_presentations/monday/JeffBonwick-BillMoore_ZFS.pdf slides] from a ZFS overview at SNIA 2008 | ||
== Distribution-Specific User Documentation == | |||
* [https://wiki.freebsd.org/ZFS FreeBSD] doc links | |||
* 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 == | == Implementation Documentation aimed at developers == | ||
| Line 28: | Line 33: | ||
** In particular, documentation about how to test and possibly scripts for building | ** In particular, documentation about how to test and possibly scripts for building | ||
** Needs to be written/links provided by reps from those communities | ** Needs to be written/links provided by reps from those communities | ||
Revision as of 22:03, 15 August 2013
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
Distribution-Specific User Documentation
- FreeBSD doc links
- 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
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