docs: update GitHub website (#368)

* chore: replace old minio configuration file with newer one

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: add admonition markdown extension

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* docs: rewrite main website page

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* docs: add warning about datasets with secrets in them

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* docs: add examples page

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: update pipfile and ci

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* docs: add advanced usage and use-cases pages

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: add minio-conf secret to minio configuration

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: remove namespace from yaml

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: add required info for archive datasets

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: small changes

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* docs: add info on creating archive datasets

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* docs: remove old info for creating archive-based datasets

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: update link for mkdocs rendering

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: move Ceph caching to advanced features

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: move FAQ to last navigation item

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: refactor navigation using mkdocs

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

* chore: navigation updates

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

---------

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>

.github/workflows/ci.yml

@@ -1,25 +1,28 @@
-name: document
+name: Update GitHub website
 on:
   push:
     branches:
       - master
     paths:
-      - 'docs/**'
+      - "docs/**"
+      - mkdocs.yml
+      - Pipfile
+
 jobs:
-  deploy:
-    runs-on: ubuntu-20.04
+  build-and-push:
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.6
+          python-version: 3.10
       - run: python -m pip install --upgrade pipenv wheel
       - run: pipenv update
       - run: pipenv run mkdocs build
       - uses: actions/checkout@v3
         with:
-           ref: gh-pages
-           path: pages
+          ref: gh-pages
+          path: pages
       - run: |
-           cp -v pages/index.yaml site/
+          cp -v pages/index.yaml site/
       - run: pipenv run ghp-import site -p --force

Pipfile

@@ -8,6 +8,7 @@ verify_ssl = true
 [packages]
 mkdocs-material = "*"
 mkdocs-git-revision-date-localized-plugin = "*"
+mkdocs-include-markdown-plugin = "*"
 
 [requires]
-python_version = "3.6"
+python_version = "3.10"

docs/Ceph-Caching.md

@@ -1,5 +1,6 @@
-# Rook/Ceph Installation
-## Method 1 (Recommended)
+# Using Ceph for caching
+## Installation
+### Method 1 (Recommended)
 
 Inside `plugins/ceph-cache-plugin/deploy/rook` directory execute:
 ``` bash
@@ -35,12 +36,12 @@ You need also to delete the paths in defined in `dataDirHostPath` and directorie
 
 Now we can proceed with installing DLF.
 
-## Method 2 (Testing)
+### Method 2 (Testing)
 
 If you are after maximum performance we strongly advice to set up your ceph cluster according to the method above. However, for testing purposes and/or lacking of disk devices we describe a method to test this inside minikube and provide a script `plugins/ceph-cache-plugin/deploy/rook/setup_ceph_cluster.sh` that installs rook with csi-lvm storage class. 
 
 
-### Minikube installation
+#### Minikube installation
 
 First we need to have a working cluster.
 
@@ -51,7 +52,7 @@ First we need to have a working cluster.
 **NOTE2:** if you change the disk-size of the minikube command make sure to tune accordingly the following parameters
 
 
-### CSI-LVM setup
+#### CSI-LVM setup
 
 Before invoking the script you should tune according to your needs the following attributes
 
@@ -70,7 +71,7 @@ cd plugins/ceph-cache-plugin/deploy/rook && \
 ```
 
 Keep in mind that the script will uninstall any previous installations of csi-lvm and rook-ceph which made through the script. If no command line arguments are passed to the script this will result in uninstalling everything.
-# DLF Installation
+## DLF Installation
 
 Go into the root of this directory and execute:
 `make deployment`
@@ -110,7 +111,7 @@ If you execute `kubectl describe datasetinternal/example-dataset` you would see
 
 Let's try to add the caching plugin.
 
-# Ceph Caching Plugin Installation
+## Ceph Caching Plugin Installation
 
 Change into the directory and invoke:
 `make deployment`

docs/cert-manager.md

@@ -5,14 +5,14 @@ Kubernetes and OpenShift workloads, capable of provisioning self-issued
 certificates, setting up an in-house CA, and integrating with publicly available
 CAs (e.g., letsencrypt).
 
-> [!IMPORTANT]  
-> All the code samples below assume Datashim is installed in the `dlf` namespace.
+!!! info 
+    All the code samples below assume Datashim is installed in the `dlf` namespace.
 
 ## Installation
 
 In this document we will not go through how to deploy cert-manager and instead
 let the reader choose their preferred way to do so among the available ones
-listed on https://cert-manager.io/docs/installation/.
+listed on [https://cert-manager.io/docs/installation/](https://cert-manager.io/docs/installation/).
 
 ## Requesting the Certificate