Difference between revisions of "Documentation"

From OpenZFS
Jump to navigation Jump to search
Line 1: Line 1:
== High-Level ZFS Documentation ==
== High-Level ZFS Documentation ==
This is the stuff Matt, George, and Chris Siden are working on writing
* 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 ==
== Repo-Specific Developer Documentation ==
Needs to be written/links provided by reps from those communities
* 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


== Distribution-Specific User Documentation ==
== Distribution-Specific User Documentation ==
* 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?''
Summary from Confluence:
* Architectural/high-level documentation about ZFS as a whole and pointers to distro-specific documentation
** 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
* 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
** Links to user documentation (distribution)

Revision as of 18:43, 12 August 2013

High-Level ZFS Documentation

  • 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

Distribution-Specific User Documentation

  • Links to user documentation (distribution)

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