Debian/Ubuntu: Add "Overview" header

This improves the table of contents.

Signed-off-by: Richard Laager <rlaager@wiktel.com>
This commit is contained in:
Richard Laager
2020-05-22 17:01:56 -05:00
parent 0c6f1b9680
commit 3c8f6c3195
4 changed files with 34 additions and 22 deletions

View File

@@ -4,15 +4,18 @@ Debian Buster Root on ZFS
.. contents:: Table of Contents .. contents:: Table of Contents
:local: :local:
Overview
--------
Caution Caution
------- ~~~~~~~
- This HOWTO uses a whole physical disk. - This HOWTO uses a whole physical disk.
- Do not use these instructions for dual-booting. - Do not use these instructions for dual-booting.
- Backup your data. Any existing data will be lost. - Backup your data. Any existing data will be lost.
System Requirements System Requirements
------------------- ~~~~~~~~~~~~~~~~~~~
- `64-bit Debian GNU/Linux Buster Live CD w/ GUI (e.g. gnome - `64-bit Debian GNU/Linux Buster Live CD w/ GUI (e.g. gnome
iso) <https://cdimage.debian.org/mirror/cdimage/release/current-live/amd64/iso-hybrid/>`__ iso) <https://cdimage.debian.org/mirror/cdimage/release/current-live/amd64/iso-hybrid/>`__
@@ -30,7 +33,7 @@ RAM <http://wiki.freebsd.org/ZFSTuningGuide#Deduplication>`__. Enabling
deduplication is a permanent change that cannot be easily reverted. deduplication is a permanent change that cannot be easily reverted.
Support Support
------- ~~~~~~~
If you need help, reach out to the community using the `zfs-discuss If you need help, reach out to the community using the `zfs-discuss
mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__ mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__
@@ -40,7 +43,7 @@ a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__ and
mention @rlaager. mention @rlaager.
Contributing Contributing
------------ ~~~~~~~~~~~~
1) Fork and clone: https://github.com/openzfs/openzfs-docs 1) Fork and clone: https://github.com/openzfs/openzfs-docs
@@ -70,7 +73,7 @@ Contributing
Mention @rlaager. Mention @rlaager.
Encryption Encryption
---------- ~~~~~~~~~~
This guide supports three different encryption options: unencrypted, This guide supports three different encryption options: unencrypted,
LUKS (full-disk encryption), and ZFS native encryption. With any option, LUKS (full-disk encryption), and ZFS native encryption. With any option,

View File

@@ -4,20 +4,23 @@ Debian Stretch Root on ZFS
.. contents:: Table of Contents .. contents:: Table of Contents
:local: :local:
Overview
--------
Newer release available Newer release available
----------------------- ~~~~~~~~~~~~~~~~~~~~~~~
- See :doc:`Debian Buster Root on ZFS <./Debian Buster Root on ZFS>` for new installs. - See :doc:`Debian Buster Root on ZFS <./Debian Buster Root on ZFS>` for new installs.
Caution Caution
------- ~~~~~~~
- This HOWTO uses a whole physical disk. - This HOWTO uses a whole physical disk.
- Do not use these instructions for dual-booting. - Do not use these instructions for dual-booting.
- Backup your data. Any existing data will be lost. - Backup your data. Any existing data will be lost.
System Requirements System Requirements
------------------- ~~~~~~~~~~~~~~~~~~~
- `64-bit Debian GNU/Linux Stretch Live - `64-bit Debian GNU/Linux Stretch Live
CD <http://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/>`__ CD <http://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/>`__
@@ -35,7 +38,7 @@ RAM <http://wiki.freebsd.org/ZFSTuningGuide#Deduplication>`__. Enabling
deduplication is a permanent change that cannot be easily reverted. deduplication is a permanent change that cannot be easily reverted.
Support Support
------- ~~~~~~~
If you need help, reach out to the community using the `zfs-discuss If you need help, reach out to the community using the `zfs-discuss
mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__ mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__
@@ -45,7 +48,7 @@ a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__ and
mention @rlaager. mention @rlaager.
Contributing Contributing
------------ ~~~~~~~~~~~~
1) Fork and clone: https://github.com/openzfs/openzfs-docs 1) Fork and clone: https://github.com/openzfs/openzfs-docs
@@ -75,7 +78,7 @@ Contributing
Mention @rlaager. Mention @rlaager.
Encryption Encryption
---------- ~~~~~~~~~~
This guide supports two different encryption options: unencrypted and This guide supports two different encryption options: unencrypted and
LUKS (full-disk encryption). ZFS native encryption has not yet been LUKS (full-disk encryption). ZFS native encryption has not yet been

View File

@@ -4,20 +4,23 @@ Ubuntu 16.04 Root on ZFS
.. contents:: Table of Contents .. contents:: Table of Contents
:local: :local:
Overview
--------
Newer release available Newer release available
----------------------- ~~~~~~~~~~~~~~~~~~~~~~~
- See :doc:`Ubuntu 18.04 Root on ZFS <./Ubuntu 18.04 Root on ZFS>` for new installs. - See :doc:`Ubuntu 18.04 Root on ZFS <./Ubuntu 18.04 Root on ZFS>` for new installs.
Caution Caution
------- ~~~~~~~
- This HOWTO uses a whole physical disk. - This HOWTO uses a whole physical disk.
- Do not use these instructions for dual-booting. - Do not use these instructions for dual-booting.
- Backup your data. Any existing data will be lost. - Backup your data. Any existing data will be lost.
System Requirements System Requirements
------------------- ~~~~~~~~~~~~~~~~~~~
- `64-bit Ubuntu 16.04.5 ("Xenial") Desktop - `64-bit Ubuntu 16.04.5 ("Xenial") Desktop
CD <http://releases.ubuntu.com/16.04/ubuntu-16.04.5-desktop-amd64.iso>`__ CD <http://releases.ubuntu.com/16.04/ubuntu-16.04.5-desktop-amd64.iso>`__
@@ -35,7 +38,7 @@ RAM <http://wiki.freebsd.org/ZFSTuningGuide#Deduplication>`__. Enabling
deduplication is a permanent change that cannot be easily reverted. deduplication is a permanent change that cannot be easily reverted.
Support Support
------- ~~~~~~~
If you need help, reach out to the community using the `zfs-discuss If you need help, reach out to the community using the `zfs-discuss
mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__ mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__
@@ -45,7 +48,7 @@ a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__ and
mention @rlaager. mention @rlaager.
Contributing Contributing
------------ ~~~~~~~~~~~~
1) Fork and clone: https://github.com/openzfs/openzfs-docs 1) Fork and clone: https://github.com/openzfs/openzfs-docs
@@ -75,7 +78,7 @@ Contributing
Mention @rlaager. Mention @rlaager.
Encryption Encryption
---------- ~~~~~~~~~~
This guide supports the three different Ubuntu encryption options: This guide supports the three different Ubuntu encryption options:
unencrypted, LUKS (full-disk encryption), and eCryptfs (home directory unencrypted, LUKS (full-disk encryption), and eCryptfs (home directory

View File

@@ -4,15 +4,18 @@ Ubuntu 18.04 Root on ZFS
.. contents:: Table of Contents .. contents:: Table of Contents
:local: :local:
Overview
--------
Caution Caution
------- ~~~~~~~
- This HOWTO uses a whole physical disk. - This HOWTO uses a whole physical disk.
- Do not use these instructions for dual-booting. - Do not use these instructions for dual-booting.
- Backup your data. Any existing data will be lost. - Backup your data. Any existing data will be lost.
System Requirements System Requirements
------------------- ~~~~~~~~~~~~~~~~~~~
- `Ubuntu 18.04.3 ("Bionic") Desktop - `Ubuntu 18.04.3 ("Bionic") Desktop
CD <http://releases.ubuntu.com/18.04.3/ubuntu-18.04.3-desktop-amd64.iso>`__ CD <http://releases.ubuntu.com/18.04.3/ubuntu-18.04.3-desktop-amd64.iso>`__
@@ -29,7 +32,7 @@ RAM <http://wiki.freebsd.org/ZFSTuningGuide#Deduplication>`__. Enabling
deduplication is a permanent change that cannot be easily reverted. deduplication is a permanent change that cannot be easily reverted.
Support Support
------- ~~~~~~~
If you need help, reach out to the community using the `zfs-discuss If you need help, reach out to the community using the `zfs-discuss
mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__ mailing list <https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists>`__
@@ -39,7 +42,7 @@ a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__ and
mention @rlaager. mention @rlaager.
Contributing Contributing
------------ ~~~~~~~~~~~~
1) Fork and clone: https://github.com/openzfs/openzfs-docs 1) Fork and clone: https://github.com/openzfs/openzfs-docs
@@ -69,7 +72,7 @@ Contributing
Mention @rlaager. Mention @rlaager.
Encryption Encryption
---------- ~~~~~~~~~~
This guide supports two different encryption options: unencrypted and This guide supports two different encryption options: unencrypted and
LUKS (full-disk encryption). ZFS native encryption has not yet been LUKS (full-disk encryption). ZFS native encryption has not yet been