Jonathan Watt ddc56b0106 Switch open-zfs.org links to openzfs.org, and use HTTPS URLs
The open-zfs.org host, Dreamhost, returns a page for https://open-zfs.org
(note, httpS://) which causes HTTPS Everywhere with the 'Encrypt All
Eligible Sites' option enabled to redirect http://open-zfs.org to
https://open-zfs.org, and therefore fail to redirect to openzfs.org.
Ideally a redirect would be implemented at Dreamhost for
httpS://open-zfs.org too, but presumably the links in the docs should
really be updated anyway.
2020-06-17 20:19:49 +03:00
2020-06-05 20:24:09 +03:00
2020-05-27 13:12:55 -05: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 pip3
   # For RPM-based distros
   sudo yum install 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%