use tabsets in quickstart instructions (#222)

* use tabsets in quickstart instructions * use tabsets in quickstart instructions
cvmfs · Nov 24, 2023 · 78db71e · 78db71e
1 parent 848a245
commit 78db71e
Show file tree

Hide file tree

Showing 3 changed files with 75 additions and 61 deletions.
diff --git a/conf.py b/conf.py
@@ -34,6 +34,7 @@
     'sphinxcontrib.mermaid',
     'sphinx_rtd_theme',
     'sphinxcontrib.cairosvgconverter',
+    'sphinx_design',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/cpt-quickstart.rst b/cpt-quickstart.rst
@@ -21,103 +21,113 @@ Getting the Software
 The CernVM-FS source code and binary packages are available from the `CernVM website <https://cernvm.cern.ch/portal/filesystem/downloads>`_.
 However, it is recommended to use the available package repositories that are also provided for the supported operating systems.
 
-Scientific Linux/CentOS
-~~~~~~~~~~~~~~~~~~~~~~~
-To add the CVMFS repository and install CVMFS run
+Linux
+~~~~~~~~~~~~~~~~
 
-::
+To add the CVMFS repository (available for Debian and RHEL flavors) and install CVMFS, run:
 
-    sudo yum install https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest.noarch.rpm
-    sudo yum install -y cvmfs
 
-Debian/Ubuntu
-~~~~~~~~~~~~~
-To add the CVMFS repository and install CVMFS run
+.. tab-set::
 
-::
+   .. tab-item:: Scientific Linux / RHEL / Alma
 
-    wget https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest_all.deb
-    sudo dpkg -i cvmfs-release-latest_all.deb
-    rm -f cvmfs-release-latest_all.deb
-    sudo apt-get update
-    sudo apt-get install cvmfs
+      .. code-block:: console
 
-Fedora
-~~~~~~
-To install the CVMFS package run
+         sudo yum install https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest.noarch.rpm
+         sudo yum install -y cvmfs
 
-::
+   .. tab-item:: Debian/Ubuntu
+
+      .. code-block:: console
+
+         wget https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest_all.deb
+         sudo dpkg -i cvmfs-release-latest_all.deb
+         rm -f cvmfs-release-latest_all.deb
+         sudo apt-get update
+         sudo apt-get install cvmfs
 
-    sudo dnf install https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0-1.fc34.x86_64.rpm https://ecsft.cern.ch/dist/cvmfs/cvmfs-config/cvmfs-config-default-latest.noarch.rpm http://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-libs-2.11.0-1.fc34.x86_64.rpm
 
+   .. tab-item:: Fedora
 
-Docker Container
+      .. code-block:: console
+
+         sudo dnf install https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0-1.fc34.x86_64.rpm \
+                          https://ecsft.cern.ch/dist/cvmfs/cvmfs-config/cvmfs-config-default-latest.noarch.rpm \
+                          http://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-libs-2.11.0-1.fc34.x86_64.rpm
+
+
+Other Platforms
 ~~~~~~~~~~~~~~~~
 
-The CernVM-FS service container can expose the ``/cvmfs`` directory tree to the host.
-Import the container with
+.. tab-set::
 
-::
+   .. tab-item:: Service Container
 
-    docker pull registry.cern.ch/cvmfs/service:latest
+      The CernVM-FS service container can expose the ``/cvmfs`` directory tree to the host.
+      Import the container with
 
-or with
+      .. code-block:: console
 
-::
+          docker pull registry.cern.ch/cvmfs/service:latest
 
-    curl https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-service-2.11.0-1.x86_64.docker.tar.gz | docker load
+      or with
 
-Run the container as a system service with
+      .. code-block:: console
 
-::
+          curl https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-service-2.11.0-1.x86_64.docker.tar.gz | docker load
 
-    docker run -d --rm \
-      -e CVMFS_CLIENT_PROFILE=single \
-      -e CVMFS_REPOSITORIES=sft.cern.ch,... \
-      --cap-add SYS_ADMIN \
-      --device /dev/fuse \
-      --volume /cvmfs:/cvmfs:shared \
-      cvmfs/service:2.8.0-1
+      Run the container as a system service with
 
-Use ``docker stop`` to unmount the ``/cvmfs`` tree.
+      .. code-block:: console
 
-.. note::
-    If you run multiple nodes (a cluster), use ``-e CVMFS_HTTP_PROXY`` to set a proper site proxy as described further down.
+          docker run -d --rm \
+            -e CVMFS_CLIENT_PROFILE=single \
+            -e CVMFS_REPOSITORIES=sft.cern.ch,... \
+            --cap-add SYS_ADMIN \
+            --device /dev/fuse \
+            --volume /cvmfs:/cvmfs:shared \
+            cvmfs/service:2.8.0-1
 
-Mac OS X
-~~~~~~~~
+      Use ``docker stop`` to unmount the ``/cvmfs`` tree.
 
-On Mac OS X, CernVM-FS is based on `macFUSE <http://osxfuse.github.io>`_.
-Note that as of macOS 11 Big Sur, `kernel extensions need to be enabled <https://support.apple.com/guide/mac-help/change-startup-disk-security-settings-a-mac-mchl768f7291/mac>`_
-to install macFUSE.
-Verify that fuse is available with
+      .. note::
+          If you run multiple nodes (a cluster), use ``-e CVMFS_HTTP_PROXY`` to set a proper site proxy as described further down.
 
-::
 
-    kextstat | grep -i fuse
+   .. tab-item:: Mac OS X
 
-Download the CernVM-FS client package in the terminal in order to avoid signature warnings
+      On Mac OS X, CernVM-FS is based on `macFUSE <http://osxfuse.github.io>`_.
+      Note that as of macOS 11 Big Sur, `kernel extensions need to be enabled <https://support.apple.com/guide/mac-help/change-startup-disk-security-settings-a-mac-mchl768f7291/mac>`_
+      to install macFUSE.
+      Verify that fuse is available with
 
-::
+      .. code-block:: console
 
-    curl -o ~/Downloads/cvmfs-2.11.0.pkg https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0.pkg
+          kextstat | grep -i fuse
 
-Install the CernVM-FS package by opening the .pkg file and reboot.
-Future releases will provide a signed and notarized package.
+      Download the CernVM-FS client package in the terminal in order to avoid signature warnings
 
+      .. code-block:: console
 
-Windows / WSL2
-~~~~~~~~~~~~~~
+          curl -o ~/Downloads/cvmfs-2.11.0.pkg https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0.pkg
 
-Follow the `Windows instructions <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ to install the Windows Subsystem for Linux (WSL2).
-Install any of the Linux distributions and follow the instructions for the distribution in this guide.
-Whenever you open the Linux distribution, run
+      Install the CernVM-FS package by opening the .pkg file and reboot.
+      Future releases will provide a signed and notarized package.
 
-::
 
-    sudo cvmfs_config wsl2_start
+   .. tab-item:: Windows / WSL2
+
+      Follow the `Windows instructions <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ to install the Windows Subsystem for Linux (WSL2).
+      Install any of the Linux distributions and follow the instructions for the distribution in this guide.
+      Whenever you open the Linux distribution, run
+
+      .. code-block:: console
+
+          sudo cvmfs_config wsl2_start
+
+      to start the CernVM-FS service.
+
 
-to start the CernVM-FS service.
 
 
 Setting up the Software

diff --git a/requirements.txt b/requirements.txt
@@ -9,7 +9,10 @@ recommonmark
 sphinx-rtd-theme
 readthedocs-sphinx-ext
 jinja2
+sphinx_design
+
 # for conversion of svgs to use in latex
 cairosvg
 sphinxcontrib-svg2pdfconverter
 
+