Difference between revisions of "Documentation"

From OpenZFS
Jump to navigation Jump to search
Line 7: Line 7:


== Distribution-Specific User Documentation ==
== Distribution-Specific User Documentation ==
* [https://wiki.freebsd.org/ZFS FreeBSD] doc links
* '''FreeBSD'''
** Manual pages: [http://www.freebsd.org/cgi/man.cgi?query=zfs&manpath=FreeBSD+8.4-RELEASE zfs] [http://www.freebsd.org/cgi/man.cgi?query=zpool&manpath=FreeBSD+8.4-RELEASE zpool] [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]
* Links to user documentation (distribution)
* Links to user documentation (distribution)
''Do we want this here or should this just be part of the links to other distributions?''
''Do we want this here or should this just be part of the links to other distributions?''

Revision as of 09:12, 18 August 2013

General Documentation aimed at users / system administrators

Distribution-Specific User Documentation

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

Implementation Documentation aimed at developers

  • 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