Skip to content

Contributing

Jump to bottom
Jorgen Lundman edited this page Apr 19, 2026 · 1 revision

Contributing to the Wiki

The project wiki aims to be clear, practical, and comprehensive, especially where OpenZFS on OS X has platform-specific behavior or caveats.

To make that possible, contributions from people with real experience using and testing O3X are incredibly valuable.

Please approach documentation with the same care you would use when protecting your own data. Other users may follow your recommendations and instructions directly, so always make it clear when something is experimental, risky, or potentially destructive.

Ideas for Topics to Write About

  • Best-practice backup procedures using rsync
  • Best-practice backup procedures using snapshots and zfs send / zfs receive
  • How you organize your datasets
  • When to use ZVOLs versus sparsebundles
  • Time Machine setup
  • Restoring from a Time Machine backup stored on ZFS
  • Peculiarities when sharing over AFP, SMB, or NFS
  • Workarounds for third-party software issues
  • Alternatives to Spotlight that work well with O3X
  • Anything else you think other users should know

Please add to this list if there is something you would like others to consider documenting.

Editing

For GitHub wiki pages, standard Markdown is enough for most documentation.

Try to keep pages:

  • clear
  • practical
  • accurate
  • explicit about risk

Clone this wiki locally