Difference between revisions of "Documentation"

From OpenZFS
Jump to navigation Jump to search
(Move user/sysadmin documentation to its own page.)
 
(23 intermediate revisions by 9 users not shown)
Line 1: Line 1:
== General Documentation aimed at users / system administrators ==
== [[System Administration | General documentation aimed at users / system administrators]] ==
* 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


== 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]
 
=== 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 [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.
* Blog posts on specific ZFS features
** [https://blogs.oracle.com/ahrens/entry/is_it_magic snapshots]
** [https://blogs.oracle.com/ahrens/entry/new_scrub_code scrub/resilver]
** [https://blogs.oracle.com/perrin/entry/the_lumberjack ZIL] (ZFS Intent Log)
** [https://blogs.oracle.com/bonwick/entry/space_maps space maps] and [https://blogs.oracle.com/bonwick/en_US/entry/zfs_block_allocation block allocation]
** [https://blogs.oracle.com/eschrock/entry/zfs_hot_spares Hot spares]
** [https://blogs.oracle.com/bonwick/en_US/entry/zfs_dedup Deduplication]
** [https://blogs.oracle.com/bonwick/en_US/entry/raid_z 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

Latest revision as of 16:45, 6 August 2015