From ac8edc15130ff37d66d68cb9c2f30daa7f60a6b8 Mon Sep 17 00:00:00 2001 From: David Sterba Date: Fri, 1 Dec 2023 00:53:40 +0100 Subject: [PATCH] btrfs-progs: docs: restyle the landing page Add an introductory paragraph with most important links, put TOC listings to columns. [ci skip] Signed-off-by: David Sterba --- Documentation/Status.rst | 2 +- Documentation/_static/style.css | 9 +++++++++ Documentation/index.rst | 34 ++++++++++++++++++++++++++++++++- 3 files changed, 43 insertions(+), 2 deletions(-) diff --git a/Documentation/Status.rst b/Documentation/Status.rst index 3e56e434..efe36c3b 100644 --- a/Documentation/Status.rst +++ b/Documentation/Status.rst @@ -388,7 +388,7 @@ are unaffected by the zoned device constraints. Details that do not fit the table -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------- Defrag ^^^^^^ diff --git a/Documentation/_static/style.css b/Documentation/_static/style.css index ee529d3c..14f2f691 100644 --- a/Documentation/_static/style.css +++ b/Documentation/_static/style.css @@ -35,3 +35,12 @@ .statusincompat { color: goldenrod; }; + +table.main-table { + border: 1px; + width: 100%; +} + +td.main-table-col { + width: 33%; +} diff --git a/Documentation/index.rst b/Documentation/index.rst index 32c7655c..21f7bb30 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -3,6 +3,17 @@ Welcome to BTRFS documentation! =============================== +BTRFS is a modern copy on write (COW) filesystem for Linux aimed at +implementing advanced features while also focusing on fault tolerance, repair +and easy administration. You can read more about the features in the +:doc:`introduction` or choose from the pages below. Documentation +for for command line tools :doc:`btrfs`, :doc:`mkfs.btrfs` and others +is in the :doc:`manual pages`. + +.. raw:: html + +
+ .. toctree:: :maxdepth: 1 :caption: Overview @@ -20,9 +31,13 @@ Welcome to BTRFS documentation! INSTALL Source-repositories +.. raw:: html + + + .. toctree:: :maxdepth: 1 - :caption: Features: + :caption: Features Common-features Custom-ioctls @@ -48,6 +63,10 @@ Welcome to BTRFS documentation! Volume-management Zoned-mode +.. raw:: html + + + .. toctree:: :maxdepth: 1 :caption: Developer documentation @@ -64,6 +83,19 @@ Welcome to BTRFS documentation! dev/ReleaseChecklist btrfs-ioctl + +.. raw:: html + +
+ +.. raw:: html + +
+ +This documentation is still work in progress, not everything from the original +wiki https://btrfs.wiki.kernel.org has been moved here. Below are starting points +for missing contents. + .. toctree:: :maxdepth: 1 :caption: TODO