Difference between revisions of "Documentation"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
== High-Level ZFS Documentation == | == High-Level ZFS Documentation == | ||
* 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] | |||
* Architectural/high-level documentation about ZFS as a whole | * Architectural/high-level documentation about ZFS as a whole | ||
** We should collaborate on this with a wiki before the launch | ** We should collaborate on this with a wiki before the launch |
Revision as of 21:18, 15 August 2013
High-Level ZFS Documentation
- manual pages from illumos; better-rendered pages would be appreciated
- 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?