diff --git a/docs/_Sidebar.rst b/docs/_Sidebar.rst deleted file mode 100644 index af7b4b8..0000000 --- a/docs/_Sidebar.rst +++ /dev/null @@ -1,49 +0,0 @@ -- [[Home]] -- [[Getting Started]] - - - `ArchLinux `__ - - [[Debian]] - - [[Fedora]] - - `FreeBSD `__ - - `Gentoo `__ - - `openSUSE `__ - - [[RHEL and CentOS]] - - [[Ubuntu]] - -- [[Project and Community]] - - - [[Admin Documentation]] - - [[FAQ]] - - [[Mailing Lists]] - - `Releases `__ - - [[Signing Keys]] - - `Issue Tracker `__ - - `Roadmap `__ - -- [[Developer Resources]] - - - [[Custom Packages]] - - [[Building ZFS]] - - `Buildbot - Status `__ - - `Buildbot Issue - Tracking `__ - - `Buildbot - Options `__ - - `OpenZFS - Tracking `__ - - [[OpenZFS Patches]] - - [[OpenZFS Exceptions]] - - `OpenZFS - Documentation `__ - - [[Git and GitHub for beginners]] - -- Performance and Tuning - - - [[ZFS on Linux Module Parameters]] - - `ZFS Transaction Delay and Write - Throttle `__ - - [[ZIO Scheduler]] - - [[Checksums]] - - `Asynchronous - Writes `__ diff --git a/docs/_TableOfContents.rst b/docs/_TableOfContents.rst new file mode 100644 index 0000000..361b3d1 --- /dev/null +++ b/docs/_TableOfContents.rst @@ -0,0 +1,9 @@ +.. toctree:: + :maxdepth: 2 + :glob: + + Getting Started/index + Project and Community/index + Developer Resources/index + Performance and tuning/index + Basics concepts/index diff --git a/docs/Home.rst b/docs/index.rst similarity index 67% rename from docs/Home.rst rename to docs/index.rst index 407e47d..5da812c 100644 --- a/docs/Home.rst +++ b/docs/index.rst @@ -1,15 +1,15 @@ -.. raw:: html +OpenZFS index +============= -

[[/img/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png|alt=openzfs]]

- -Welcome to the OpenZFS GitHub wiki. This wiki provides documentation for +Welcome to the OpenZFS. This resource provides documentation for users and developers working with (or contributing to) the OpenZFS project. New users or system administrators should refer to the documentation for their favorite platform to get started. +----------------------+----------------------+----------------------+ -| [[Getting Started]] | [[Project and | [[Developer | -| | Community]] | Resources]] | +| :doc:`Getting Started| :doc:`Project and | :doc:`Developer | +| <./Getting | Community <./Project | Resources ` | and Community>` | Resources/index>` | +======================+======================+======================+ | How to get started | About the project | Technical | | with OpenZFS on your | and how to | documentation | @@ -17,3 +17,8 @@ documentation for their favorite platform to get started. | | | OpenZFS | | | | implementation | +----------------------+----------------------+----------------------+ + + +Table of Contents: +------------------ +.. include:: _TableOfContents.rst