diff --git a/docs/Admin-Documentation.rst b/docs/Project and Community/Admin Documentation.rst similarity index 88% rename from docs/Admin-Documentation.rst rename to docs/Project and Community/Admin Documentation.rst index 27bbf7c..9e8bd6f 100644 --- a/docs/Admin-Documentation.rst +++ b/docs/Project and Community/Admin Documentation.rst @@ -1,3 +1,6 @@ +Admin Documentation +=================== + - `Aaron Toponce's ZFS on Linux User Guide `__ - `OpenZFS System diff --git a/docs/hole_birth-FAQ.rst b/docs/Project and Community/FAQ hole birth.rst similarity index 100% rename from docs/hole_birth-FAQ.rst rename to docs/Project and Community/FAQ hole birth.rst diff --git a/docs/FAQ.rst b/docs/Project and Community/FAQ.rst similarity index 93% rename from docs/FAQ.rst rename to docs/Project and Community/FAQ.rst index 7f244a7..def929e 100644 --- a/docs/FAQ.rst +++ b/docs/Project and Community/FAQ.rst @@ -1,48 +1,8 @@ -Table Of Contents ------------------ +FAQ +=== -- `What is ZFS on Linux <#what-is-zfs-on-linux>`__ -- `Hardware Requirements <#hardware-requirements>`__ -- `Do I have to use ECC memory for - ZFS? <#do-i-have-to-use-ecc-memory-for-zfs>`__ -- `Installation <#installation>`__ -- `Supported Architectures <#supported-architectures>`__ -- `Supported Kernels <#supported-kernels>`__ -- `32-bit vs 64-bit Systems <#32-bit-vs-64-bit-systems>`__ -- `Booting from ZFS <#booting-from-zfs>`__ -- `Selecting /dev/ names when creating a - pool <#selecting-dev-names-when-creating-a-pool>`__ -- `Setting up the /etc/zfs/vdev_id.conf - file <#setting-up-the-etczfsvdev_idconf-file>`__ -- `Changing /dev/ names on an existing - pool <#changing-dev-names-on-an-existing-pool>`__ -- `The /etc/zfs/zpool.cache file <#the-etczfszpoolcache-file>`__ -- `Generating a new /etc/zfs/zpool.cache - file <#generating-a-new-etczfszpoolcache-file>`__ -- `Sending and Receiving Streams <#sending-and-receiving-streams>`__ - - - `hole_birth Bugs <#hole_birth-bugs>`__ - - `Sending Large Blocks <#sending-large-blocks>`__ - -- `CEPH/ZFS <#cephzfs>`__ - - - `ZFS Configuration <#zfs-configuration>`__ - - `CEPH Configuration (ceph.conf} <#ceph-configuration-cephconf>`__ - - `Other General Guidelines <#other-general-guidelines>`__ - -- `Performance Considerations <#performance-considerations>`__ -- `Advanced Format Disks <#advanced-format-disks>`__ -- `ZVOL used space larger than - expected <#ZVOL-used-space-larger-than-expected>`__ -- `Using a zvol for a swap device <#using-a-zvol-for-a-swap-device>`__ -- `Using ZFS on Xen Hypervisor or Xen - Dom0 <#using-zfs-on-xen-hypervisor-or-xen-dom0>`__ -- `udisks2 creates /dev/mapper/ entries for - zvol <#udisks2-creating-devmapper-entries-for-zvol>`__ -- `Licensing <#licensing>`__ -- `Reporting a problem <#reporting-a-problem>`__ -- `Does ZFS on Linux have a Code of - Conduct? <#does-zfs-on-linux-have-a-code-of-conduct>`__ +.. contents:: Table of Contents + :local: What is ZFS on Linux -------------------- @@ -94,7 +54,7 @@ Installation ------------ ZFS on Linux is available for all major Linux distributions. Refer to -the [[getting started]] section of the wiki for links to installations +the :doc:`getting started <../Getting Started/index>` section of the wiki for links to installations instructions for many popular distributions. If your distribution isn't listed you can always build ZFS on Linux from the latest official `tarball `__. @@ -153,7 +113,9 @@ Booting from ZFS ---------------- Booting from ZFS on Linux is possible and many people do it. There are -excellent walk throughs available for [[Debian]], [[Ubuntu]] and +excellent walk throughs available for +:doc:`Debian <../Getting Started/Debian/index>`, +:doc:`Ubuntu <../Getting Started/Ubuntu/index>`, and `Gentoo `__. Selecting /dev/ names when creating a pool @@ -424,7 +386,7 @@ will not match the source*. ZoL versions 0.6.5.8 and 0.7.0-rc1 (and above) default to ignoring the faulty metadata which causes this issue *on the sender side*. -For more details, see the [[hole_birth FAQ]]. +For more details, see the :doc:`hole_birth FAQ <./FAQ hole birth>`. Sending Large Blocks ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/Mailing-Lists.rst b/docs/Project and Community/Mailing Lists.rst similarity index 78% rename from docs/Mailing-Lists.rst rename to docs/Project and Community/Mailing Lists.rst index 28096b3..d48f0e2 100644 --- a/docs/Mailing-Lists.rst +++ b/docs/Project and Community/Mailing Lists.rst @@ -1,27 +1,30 @@ +Mailing Lists +============= + +----------------------+----------------------+----------------------+ |              | Description | List Archive | |             List     | | | |                      | | | +======================+======================+======================+ -| `zfs-annou | A low-traffic list | `arch | -| nce@list.zfsonlinux. | for announcements | ive `__ | | ups/zfs-announce>`__ | | | +----------------------+----------------------+----------------------+ -| `zfs-dis | A user discussion | `arc | -| cuss@list.zfsonlinux | list for issues | hive `__ | | oups/zfs-discuss>`__ | usability | | +----------------------+----------------------+----------------------+ -| `zfs | A development list | `a | -| -devel@list.zfsonlin | for developers to | rchive `__ | | groups/zfs-devel>`__ | | | +----------------------+----------------------+----------------------+ -| `devel | A | `archive `__ | | iki/Mailing_list>`__ | developers to review | | diff --git a/docs/Signing-Keys.rst b/docs/Project and Community/Signing Keys.rst similarity index 98% rename from docs/Signing-Keys.rst rename to docs/Project and Community/Signing Keys.rst index 90d1cac..799acb8 100644 --- a/docs/Signing-Keys.rst +++ b/docs/Project and Community/Signing Keys.rst @@ -1,3 +1,6 @@ +Signing Keys +============ + All tagged ZFS on Linux `releases `__ are signed by the official maintainer for that branch. These signatures are diff --git a/docs/Project and Community/index.rst b/docs/Project and Community/index.rst new file mode 100644 index 0000000..606726d --- /dev/null +++ b/docs/Project and Community/index.rst @@ -0,0 +1,12 @@ +Project and Community +===================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + * + Issue Tracker + Releases + Roadmap diff --git a/docs/Project-and-Community.rst b/docs/Project-and-Community.rst deleted file mode 100644 index b52a8a2..0000000 --- a/docs/Project-and-Community.rst +++ /dev/null @@ -1,24 +0,0 @@ -OpenZFS is storage software which combines the functionality of -traditional filesystems, volume manager, and more. OpenZFS includes -protection against data corruption, support for high storage capacities, -efficient data compression, snapshots and copy-on-write clones, -continuous integrity checking and automatic repair, remote replication -with ZFS send and receive, and RAID-Z. - -OpenZFS brings together developers from the illumos, Linux, FreeBSD and -OS X platforms, and a wide range of companies -- both online and at the -annual OpenZFS Developer Summit. High-level goals of the project include -raising awareness of the quality, utility and availability of -open-source implementations of ZFS, encouraging open communication about -ongoing efforts toward improving open-source variants of ZFS, and -ensuring consistent reliability, functionality and performance of all -distributions of ZFS. - -| `Admin - Documentation `__ -| [[FAQ]] -| [[Mailing Lists]] -| `Releases `__ -| `Issue Tracker `__ -| `Roadmap `__ -| [[Signing Keys]]