Difference between revisions of "Documentation"

From OpenZFS
Jump to navigation Jump to search
m
(Move user/sysadmin documentation to its own page.)
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== General Documentation aimed at users / system administrators ==
== [[System Administration | General documentation aimed at users / system administrators]] ==
* [[Features]]
* [[Publications | Publications and conference talks]]
* [[History]]
* [[Performance Tuning]]
* manual pages
** ''from illumos; better-rendered pages would be appreciated''
** [http://illumos.org/man/1m/zpool zpool] [http://illumos.org/man/1m/zfs zfs] [http://illumos.org/man/5/zpool-features zpool-features] [http://illumos.org/man/1m/zdb zdb] [http://illumos.org/man/1m/zstreamdump zstreamdump]
* 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
* Seems applicable to most platforms, but maybe getting out-of-date:
** [http://www.solarisinternals.com/wiki/index.php/ZFS_Configuration_Guide ZFS Configuration Guide]
** [http://www.solarisinternals.com/wiki/index.php/ZFS_Best_Practices_Guide ZFS Best Practices Guide]
** [http://www.solarisinternals.com/wiki/index.php/ZFS_Evil_Tuning_Guide ZFS Evil Tuning Guide]


== Distribution-Specific User Documentation ==
== [[Developer resources | Implementation documentation for developers]] ==
=== 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]
* [https://wiki.freebsd.org/ZFS FreeBSD ZFS Wiki]
 
=== Gentoo ===
* [https://wiki.gentoo.org/wiki/ZFS Wiki page]
* [https://github.com/ryao/zfs-overlay/blob/master/zfs-install 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?''
 
== [[Resources | Implementation Documentation for Developers]] ==

Latest revision as of 16:45, 6 August 2015