Difference between revisions of "Documentation"
Jump to navigation
Jump to search
(Change manpage order to match illumos) |
|||
| Line 8: | Line 8: | ||
== Distribution-Specific User Documentation == | == Distribution-Specific User Documentation == | ||
* '''FreeBSD''' | * '''FreeBSD''' | ||
** | ** manual pages: [http://www.freebsd.org/cgi/man.cgi?query=zpool&manpath=FreeBSD+8.4-RELEASE zpool] [http://www.freebsd.org/cgi/man.cgi?query=zfs&manpath=FreeBSD+8.4-RELEASE zfs] [http://www.freebsd.org/cgi/man.cgi?query=zpool-features&manpath=FreeBSD+8.4-RELEASE zpool-features] [http://www.freebsd.org/cgi/man.cgi?query=zdb&manpath=FreeBSD+8.4-RELEASE zdb] [http://www.freebsd.org/cgi/man.cgi?query=zstreamdump&manpath=FreeBSD+8.4-RELEASE zstreamdump] | ||
** ZFS page in [http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/filesystems-zfs.html The FreeBSD Handbook] | ** ZFS page in [http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/filesystems-zfs.html The FreeBSD Handbook] | ||
** [https://wiki.freebsd.org/ZFS FreeBSD ZFS Wiki] | ** [https://wiki.freebsd.org/ZFS FreeBSD ZFS Wiki] | ||
Revision as of 09:13, 18 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
- manual pages: zpool zfs zpool-features zdb zstreamdump
- ZFS page in The FreeBSD Handbook
- FreeBSD ZFS Wiki
- 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