Refactor some docs.

ani2fun · Sep 6, 2024 · 82bd8e2 · 82bd8e2
1 parent 692144e
commit 82bd8e2
Show file tree

Hide file tree

Showing 15 changed files with 39 additions and 58 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -5,17 +5,15 @@
 ## 🛠️ Infrastructure Setup
 
 - [Infrastructure](./infrastructure/infrastructure-introduction.md)
-    - [🚀 Kubernetes with K3S & Wireguard VPN](./infrastructure/k3s/toc.md)
-        - [🌐 Introduction](./infrastructure/k3s/introduction.md)
+    - [🚀 Kubernetes with K3S](./infrastructure/k3s/introduction.md)
         - [🛠️ Preparing Environment](./infrastructure/k3s/preparing-environment.md)
         - [🔐 WireGuard Setup](./infrastructure/k3s/wireguard-setup.md)
         - [🦾 K3s Installation](./infrastructure/k3s/k3s-installation.md)
         - [🌍 MetalLB and Nginx Setup](./infrastructure/k3s/metallb-and-nginx-setup.md)
         - [🔒 Ingress with Cert-Manager](./infrastructure/k3s/ingress-cert-manager.md)
         - [❌ Uninstalling K3s](./infrastructure/k3s/uninstalling-k3s.md)
         - [🚧 ArgoCD Installation](./infrastructure/k3s/argocd-installation.md)
-    - [🚀Kubernetes with K0S](./infrastructure/k0s/toc.md)
-        - [🌐 Kubernetes Setup with k0s](./infrastructure/k0s/k0s-setup.md)
+    - [🚀Kubernetes with K0S](./infrastructure/k0s/k0s-setup.md)
         - [🌍 Nginx Setup](./infrastructure/k0s/nginx-setup.md)
         - [🚧 Argo Setup (wip)](./infrastructure/k0s/argocd-setup.md)
 

diff --git a/src/computer-science/OS/commands.md b/src/computer-science/OS/commands.md
@@ -1,4 +1,4 @@
-# Commands
+## Commands
 
 - Remove specific Dir and it's sub-dir
     ```bash
@@ -13,6 +13,7 @@
     for file in *.java; do mv "$file" "${file%.java}.kt"; done
     ```
 
-- Squash all commits
+- Squash all commits and reset
     ```bash
+     git reset $(git commit-tree HEAD^{tree} -m "Initial Commit")
     ```
diff --git a/src/computer-science/intro.md b/src/computer-science/intro.md
@@ -8,9 +8,20 @@
 
 ## Table of content
 
+---
+
 - [Commands](./OS/commands.md)
 
+---
+
 - [Docker](./mixed/docker.md)
 
+---
+
 - [Regular Expression](./mixed/regular-expression.md)
 
+---
+
+- [Http Status Codes](./mixed/http-status-codes.md)
+
+---
diff --git a/src/computer-science/mixed/docker.md b/src/computer-science/mixed/docker.md
@@ -1,4 +1,4 @@
-# Docker
+## Docker
 
 **Docker** is a leading platform-as-a-service (PaaS) tool that revolutionized the way software is developed, tested, and
 deployed.

diff --git a/src/computer-science/mixed/http-status-codes.md b/src/computer-science/mixed/http-status-codes.md
@@ -1,6 +1,6 @@
-# HTTP Status Codes
+## HTTP Status Codes
 
-## Categories
+### Categories
 
 - **1XX** status codes: Informational Requests
 - **2XX** status codes: Successful Requests

diff --git a/src/computer-science/mixed/regular-expression.md b/src/computer-science/mixed/regular-expression.md
@@ -1,4 +1,4 @@
-### Regular Expressions (Regex) Tutorial
+## Regular Expressions (Regex) Tutorial
 
 Regular expressions, or **regex**, are powerful tools for pattern matching in text. They are widely used in programming,
 text processing, and data extraction.

diff --git a/src/infrastructure/infrastructure-introduction.md b/src/infrastructure/infrastructure-introduction.md
@@ -1,13 +1,13 @@
-# Table of Content
+# Infrastructure
+
+## Table of Content
 
 ---
 
 - [🚀 Kubernetes Cluster Setup with 🦾 K3s, 🔐 WireGuard VPN, 🌐 Calico CNI, and ⚖️ MetalLB on Hybrid Infrastructure](./k3s/introduction.md)
 
-- [🚀 Kubernetes Cluster Setup Using K0S](./k0s/k0s-setup.md)
-
 ---
 
-- [Setting Up Reverse Proxy With ACME Let's Encrypt and CertBot]()
+- [🚀 Kubernetes Cluster Setup Using K0S](./k0s/k0s-setup.md)
 
 ---
diff --git a/src/infrastructure/k0s/argocd-setup.md b/src/infrastructure/k0s/argocd-setup.md
@@ -1,6 +1,11 @@
+## **Argocd Installation**
+
+### (WIP)
+
+Needs some work as there are some issues like TLS certificates management etc.
+
 https://argo-cd.readthedocs.io/en/stable/getting_started/
 
-Argocd setup needs some work as there are some issues with certificates management.
 
 ### Install Argo CD
 

diff --git a/src/infrastructure/k0s/k0s-setup.md b/src/infrastructure/k0s/k0s-setup.md
@@ -1,11 +1,13 @@
-# Two-Node Kubernetes Cluster Setup Using k0s
+## 🚀 Setting Up a Kubernetes Cluster with 🦾 K0S and 🔐 WireGuard VPN Tunneling from Cloud VM
 
 Deploying a two-node Kubernetes cluster using k0s on AlmaLinux. The setup involves configuring two nodes as both control
 plane and worker nodes, along with detailed instructions for firewall and network configurations.
 
+---
+
 ## Prerequisites
 
-### Hardware and Network
+**Hardware and Network:**
 
 - **Two Nodes**: `master-01` and `worker-01`.
 - **Operating System**: AlmaLinux 9.4 (or any compatible RHEL-based distribution).
@@ -19,7 +21,7 @@ can update the documentation:
 
 ---
 
-## Environment Setup
+### 📊 Server Overview
 
 | Role                           | Hostname                  | IP Address                   |
 |--------------------------------|---------------------------|------------------------------|

diff --git a/src/infrastructure/k0s/nginx-setup.md b/src/infrastructure/k0s/nginx-setup.md
@@ -1,4 +1,4 @@
-# 🌐 Nginx Setup:
+## 🌐 Nginx Setup:
 
 ## Configuration involving the
 `cloud-vm` with AlmaLinux 9, NGINX, Kubernetes, and the WireGuard tunnel configuration between `cloud-vm` and

diff --git a/src/infrastructure/k0s/toc.md b/src/infrastructure/k0s/toc.md
diff --git a/src/infrastructure/k3s/ingress-cert-manager.md b/src/infrastructure/k3s/ingress-cert-manager.md
@@ -1,4 +1,4 @@
-# **🔐 **Securing Ingress Using Cert-Manager****
+## **🔐 **Securing Ingress Using Cert-Manager****
 
 ---
 

diff --git a/src/infrastructure/k3s/introduction.md b/src/infrastructure/k3s/introduction.md
@@ -1,4 +1,4 @@
-## **🌐 Introduction**
+## 🚀 Setting Up a Kubernetes Cluster with 🦾 K3S, 🔐 WireGuard VPN, 🌐 Calico CNI, and ⚖️ MetalLB on Hybrid Infrastructure
 
 ---
 

diff --git a/src/infrastructure/k3s/toc.md b/src/infrastructure/k3s/toc.md
diff --git a/src/infrastructure/k3s/uninstalling-k3s.md b/src/infrastructure/k3s/uninstalling-k3s.md
@@ -1,4 +1,4 @@
-## **❌ **Uninstalling K3S****
+## **❌ Uninstalling K3S**
 
 If you want start again from scratch then uninstallation instructions are below to completely uninstall from all nodes.