Maurice Zhou 3d4931680d Arch Linux: Use bash array for multi-disk; Overview section for ZFS
package; drop Artix Linux

Arch Linux: index.rst punctuation

Arch Linux: Boot pool encryption key must not be in child dataset

Arch Linux: delete backup after restoration

Remove trailing blanks

Move topology spec above pool creation

Arch Linux: Reintroduce INST_UUID

Arch Linux: secure permissions for key file

Signed-off-by: Maurice Zhou <ja@apvc.uk>
2021-03-12 22:11:33 -06:00
2021-02-02 03:28:38 -06:00
2020-05-27 13:12:55 -05:00
2021-03-04 04:09:14 -06:00

.. image:: docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png
.. highlight:: sh

OpenZFS Documentation
=====================

Public link: https://openzfs.github.io/openzfs-docs/

Building Locally
----------------

Install Prerequisites
~~~~~~~~~~~~~~~~~~~~~

The dependencies are available via pip::

   # For Debian based distros
   sudo apt install python3-pip
   # For RPM-based distros
   sudo yum install python3-pip
   # For openSUSE
   sudo zypper in python3-pip

   pip3 install -r docs/requirements.txt
   # Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc:
   PATH=$HOME/.local/bin:$PATH

Build
~~~~~

::

   cd docs
   make html
   # HTML files will be generated in: _build/html
Description
OpenZFS Documentation
Readme 2 MiB
Languages
Python 83.7%
Shell 16.1%
Makefile 0.2%