docs: Improve mkdocs structure (#187)

Signed-off-by: Din Music <din.music@din-cloud.com>

README.md

@@ -1,6 +1,6 @@
 <div align=center>
 <h1><a href="https://kubitect.io">Kubitect</a></h1>
-<img src="docs/theme/assets/images/favicon.svg" width=200></img>
+<img src="docs/assets/images/favicon.svg" width=200></img>
 
 </br>
 

docs/examples/accessing-cluster.md

@@ -11,7 +11,7 @@ This load balancer redirects all incoming connections to the Service, as illustr
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/access-cloud-provider.png"
+    src="../../assets/images/img_access-cloud-provider.png"
     alt="Cloud provider load balancer scheme"
     width="75%">
 </div>
@@ -27,7 +27,7 @@ As a result, the Service becomes available on `<NodeIP>:<NodePort>`, as shown in
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/access-nodeport.png"
+    src="../../assets/images/img_access-nodeport.png"
     alt="Node port Service access scheme"
     width="75%">
 </div>
@@ -42,7 +42,7 @@ With Kubitect, it is possible to configure the port forwarding of the load balan
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/access-self-provisioned-edge.png"
+    src="../../assets/images/img_access-self-provisioned-edge.png"
     alt="Node port Service access scheme"
     width="75%">
 </div>

docs/examples/ha-cluster.md

@@ -11,7 +11,7 @@ The final topology of the deployed Kubernetes cluster is shown in the figure bel
 
 <div text="text-center">
   <img
-    src="../../assets/images/topology-ha-arch.png"
+    src="../../assets/images/img_topology-ha-arch.png"
     alt="Architecture of the highly available cluster"
     width="100%">
 </div>
@@ -100,7 +100,7 @@ The purpose of the failover load balancer is to serve incoming requests using th
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/topology-ha-base.png"
+    src="../../assets/images/img_topology-ha-base.png"
     alt="Scheme of highly available topology"
     width="75%">
 </div>

docs/examples/multi-master-cluster.md

@@ -14,7 +14,7 @@ The final topology of the deployed Kubernetes cluster is depicted in the figure
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/topology-3m3w1lb-arch.png"
+    src="../../assets/images/img_topology-3m3w1lb-arch.png"
     alt="Architecture of the cluster with 3 master and 3 worker nodes"
     width="75%">
 </div>
@@ -41,7 +41,7 @@ The figure below provides a visual representation of this approach.
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/topology-3m3w1lb-base.png"
+    src="../../assets/images/img_topology-3m3w1lb-base.png"
     alt="Scheme of load balancing between control plane nodes"
     width="75%">
 </div>

docs/examples/multi-worker-cluster.md

@@ -10,7 +10,7 @@ The final topology of the deployed Kubernetes cluster is shown in the figure bel
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/topology-1m3w-arch.png"
+    src="../../assets/images/img_topology-1m3w-arch.png"
     alt="Architecture of the cluster with 1 master and 3 worker nodes"
     width="75%">
 </div>

docs/examples/network-bridge.md

@@ -11,7 +11,7 @@ This example shows how to configure a simple bridge interface using [Netplan](ht
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/network-bridge.png"
+    src="../../assets/images/img_network-bridge.png"
     alt="NAT vs bridge network scheme"
     width="75%">
 </div>

docs/examples/rook-cluster.md

@@ -14,7 +14,7 @@ This additional data disk is utilized by Rook to provide reliable and scalable d
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/rook-cluster-arch.png"
+    src="../../assets/images/img_rook-cluster-arch.png"
     alt="Basic Rook cluster scheme"
     width="75%">
 </div>
@@ -162,7 +162,7 @@ Only the nodes where Rook should be deployed are labeled `#!yaml rook: true`, as
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/rook-cluster-labels.png"
+    src="../../assets/images/img_rook-cluster-labels.png"
     alt="Cluster scheme with labels to restrict Rook deployment"
     width="85%">
 </div>
@@ -202,7 +202,7 @@ We want to deploy Rook on the nodes labeled with the label `#!yaml rook: true`,
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/rook-cluster-node-selector.png"
+    src="../../assets/images/img_rook-cluster-node-selector.png"
     alt="Cluster scheme of Rook deployment with applied node selector"
     width="85%">
 </div>

docs/examples/single-node-cluster.md

@@ -11,7 +11,7 @@ The topology of the Kubernetes cluster deployed in this guide is shown below.
 <div class="text-center">
   <img
     class="mobile-w-75"
-    src="../../assets/images/topology-1m-arch.png"
+    src="../../assets/images/img_topology-1m-arch.png"
     alt="Architecture of a single node cluster"
     width="50%">
 </div>

docs/getting-started/getting-started.md

@@ -12,7 +12,7 @@ This **step-by-step** guide will walk you through the process of creating a cust
 <div class="text-center">
   <img
     class="mobile-w-75"
-    src="../../assets/images/topology-1m1w-base.png"
+    src="../../assets/images/img_topology-1m1w-base.png"
     alt="Base scheme of the cluster with one master and one worker node"
     width="50%">
 </div>
@@ -75,7 +75,7 @@ Below is an image that visualizes the components of the final cluster.
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/topology-1m1w-arch.png"
+    src="../../assets/images/img_topology-1m1w-arch.png"
     alt="Architecture of the cluster with one master and one worker node"
     width="75%">
 </div>

docs/getting-started/quick-start.md

@@ -15,7 +15,7 @@ The resulting infrastructure is shown in the image below.
 <div class="text-center">
   <img
     class="mobile-w-100"
-    src="../../assets/images/topology-1m1w-arch.png"
+    src="../../assets/images/img_topology-1m1w-arch.png"
     alt="Architecture of the cluster with one master and one worker node"
     width="75%">
 </div>

docs/theme/overrides/introduction.html → docs/introduction.html

@@ -46,7 +46,7 @@ <h2>Core goals</h2>
                 </p>
 
                 <div class="card-footer-nav">
-                    <img src="../../assets/images/network.svg" alt="">
+                    <img src="../../assets/images/icon_network.svg" alt="">
                 </div>
             </div>
 
@@ -58,7 +58,7 @@ <h2>Core goals</h2>
                 </p>
 
                 <div class="card-footer-nav">
-                    <img src="../../assets/images/handshake.svg" alt="">
+                    <img src="../../assets/images/icon_handshake.svg" alt="">
                 </div>
             </div>
         </div>
@@ -74,7 +74,7 @@ <h2>Core goals</h2>
                 </p>
 
                 <div class="card-footer-nav text-center">
-                    <img src="../../assets/images/filelaptop.svg" alt="">
+                    <img src="../../assets/images/icon_filelaptop.svg" alt="">
                 </div>
             </div>
 
@@ -87,7 +87,7 @@ <h2>Core goals</h2>
                 </p>
 
                 <div class="card-footer-nav">
-                    <img src="../../assets/images/lab.svg" alt="">
+                    <img src="../../assets/images/icon_lab.svg" alt="">
                 </div>
             </div>
 

docs/theme/overrides/main.html → docs/main.html

@@ -1,5 +1,4 @@
 {% extends "base.html" %}
-
 {% block outdated %}
   This documentation does not refer to the <a href="{{ '../' ~ base_url }}"><strong>latest version</strong></a>.
 {% endblock %}

mkdocs.yml

@@ -9,10 +9,10 @@ edit_uri: ""
 
 theme:
   name: material
-  custom_dir: docs/theme/overrides
+  custom_dir: docs/
 
-  favicon: theme/assets/images/favicon.svg
-  logo: theme/assets/images/logo_white.svg
+  favicon: assets/images/favicon.svg
+  logo: assets/images/logo_white.svg
 
   font:
     text: Ubuntu
@@ -65,10 +65,10 @@ theme:
       quote: octicons/quote-24
 
 extra_css:
-  - theme/assets/stylesheets/style.css
+  - assets/stylesheets/style.css
 
 extra_javascript:
-  - theme/assets/javascripts/extra.js
+  - assets/javascripts/extra.js
 
 extra:
   version: