From d1b9cabe5c172b73bfd1fdc0c939618c8c218d64 Mon Sep 17 00:00:00 2001 From: Mateusz Suski Date: Wed, 6 May 2026 06:46:27 +0000 Subject: [PATCH] Make README diagrams vertical and clickable --- README.md | 24 ++++--------------- infra-run/README.md | 12 +++++----- infra-run/ansible/README.md | 14 +++++------ infra-run/ansible/collections/README.md | 6 ++--- infra-run/ansible/inventory/README.md | 8 +++---- .../ansible/inventory/group_vars/README.md | 5 ++-- .../ansible/inventory/host_vars/README.md | 5 ++-- infra-run/ansible/playbooks/README.md | 6 ++--- infra-run/ansible/roles/README.md | 6 ++--- infra-run/ansible/tests/README.md | 5 ++-- infra-run/docs/README.md | 5 ++-- infra-run/runbooks/README.md | 6 ++--- infra-run/scripts/README.md | 8 +++---- infra-run/scripts/bash/README.md | 14 +++++------ infra-run/scripts/bash/disk-full/README.md | 10 ++------ infra-run/scripts/bash/gpfs/README.md | 11 ++------- .../scripts/bash/os-healthcheck/README.md | 7 ++---- infra-run/scripts/bash/veritas/README.md | 11 ++------- infra-run/scripts/python/README.md | 5 ++-- labs/README.md | 12 ++++++---- labs/ci-cd/README.md | 6 ++--- labs/docker/README.md | 5 ++-- labs/kubernetes/README.md | 6 ++--- labs/networking/README.md | 6 ++--- labs/terraform/README.md | 5 ++-- platform-projects/README.md | 12 ++++++---- platform-projects/clustering/README.md | 6 ++--- platform-projects/elk-log-analysis/README.md | 6 ++--- platform-projects/monitoring-zabbix/README.md | 6 ++--- platform-projects/storage/README.md | 6 ++--- platform-projects/virtualization/README.md | 6 ++--- 31 files changed, 92 insertions(+), 158 deletions(-) diff --git a/README.md b/README.md index ed774c2..36f903b 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,11 @@ This repository demonstrates real-world Linux infrastructure and operations expe ```mermaid flowchart TD - A["portfolio"] --> B["infra-run"] - A --> C["platform-projects"] - A --> D["labs"] - B --> B1["ansible"] - B --> B2["docs"] - B --> B3["runbooks"] - B --> B4["scripts"] - B4 --> B41["bash"] - B4 --> B42["python"] - C --> C1["storage"] - C --> C2["clustering"] - C --> C3["monitoring-zabbix"] - C --> C4["virtualization"] - C --> C5["elk-log-analysis"] - D --> D1["docker"] - D --> D2["kubernetes"] - D --> D3["terraform"] - D --> D4["networking"] - D --> D5["ci-cd"] + A["portfolio"] --> B["infra-run"] --> C["platform-projects"] --> D["labs"] + click A href "./" "portfolio" + click B href "./infra-run/" "infra-run" + click C href "./platform-projects/" "platform-projects" + click D href "./labs/" "labs" ``` ## Core Project diff --git a/infra-run/README.md b/infra-run/README.md index e150f91..013bcfd 100644 --- a/infra-run/README.md +++ b/infra-run/README.md @@ -6,12 +6,12 @@ ```mermaid flowchart TD - A["infra-run"] --> B["ansible"] - A --> C["docs"] - A --> D["runbooks"] - A --> E["scripts"] - E --> E1["bash"] - E --> E2["python"] + A["infra-run"] --> B["ansible"] --> C["docs"] --> D["runbooks"] --> E["scripts"] + click A href "./" "infra-run" + click B href "./ansible/" "ansible" + click C href "./docs/" "docs" + click D href "./runbooks/" "runbooks" + click E href "./scripts/" "scripts" ``` ## Scope diff --git a/infra-run/ansible/README.md b/infra-run/ansible/README.md index 895ada9..bb7acbf 100644 --- a/infra-run/ansible/README.md +++ b/infra-run/ansible/README.md @@ -6,13 +6,13 @@ This directory reserves the Ansible automation area for future infrastructure-as ```mermaid flowchart TD - A["ansible"] --> B["collections"] - A --> C["inventory"] - A --> D["playbooks"] - A --> E["roles"] - A --> F["tests"] - C --> C1["group_vars"] - C --> C2["host_vars"] + A["ansible"] --> B["collections"] --> C["inventory"] --> D["playbooks"] --> E["roles"] --> F["tests"] + click A href "./" "ansible" + click B href "./collections/" "collections" + click C href "./inventory/" "inventory" + click D href "./playbooks/" "playbooks" + click E href "./roles/" "roles" + click F href "./tests/" "tests" ``` ## Scope diff --git a/infra-run/ansible/collections/README.md b/infra-run/ansible/collections/README.md index 64105e4..acf55c3 100644 --- a/infra-run/ansible/collections/README.md +++ b/infra-run/ansible/collections/README.md @@ -6,10 +6,8 @@ This folder is reserved for Ansible collections used by the `infra-run` automati ```mermaid flowchart TD - A["collections"] --> B["External or custom collections"] - B --> C["Modules"] - B --> D["Plugins"] - B --> E["Roles integration"] + A["collections"] + click A href "./" "collections" ``` ## Scope diff --git a/infra-run/ansible/inventory/README.md b/infra-run/ansible/inventory/README.md index d9df4c6..7d7af38 100644 --- a/infra-run/ansible/inventory/README.md +++ b/infra-run/ansible/inventory/README.md @@ -6,10 +6,10 @@ This directory is intended for Ansible inventory definitions. It separates share ```mermaid flowchart TD - A["inventory"] --> B["group_vars"] - A --> C["host_vars"] - B --> D["Shared environment variables"] - C --> E["Per-host overrides"] + A["inventory"] --> B["group_vars"] --> C["host_vars"] + click A href "./" "inventory" + click B href "./group_vars/" "group_vars" + click C href "./host_vars/" "host_vars" ``` ## Scope diff --git a/infra-run/ansible/inventory/group_vars/README.md b/infra-run/ansible/inventory/group_vars/README.md index 85b0d01..809f3a8 100644 --- a/infra-run/ansible/inventory/group_vars/README.md +++ b/infra-run/ansible/inventory/group_vars/README.md @@ -6,9 +6,8 @@ This folder is reserved for shared Ansible variables applied to inventory groups ```mermaid flowchart TD - A["group_vars"] --> B["Environment defaults"] - A --> C["Role parameters"] - A --> D["Shared operational values"] + A["group_vars"] + click A href "./" "group_vars" ``` ## Notes diff --git a/infra-run/ansible/inventory/host_vars/README.md b/infra-run/ansible/inventory/host_vars/README.md index 6ed17dd..8847285 100644 --- a/infra-run/ansible/inventory/host_vars/README.md +++ b/infra-run/ansible/inventory/host_vars/README.md @@ -6,9 +6,8 @@ This folder is intended for host-specific Ansible variables. It complements `gro ```mermaid flowchart TD - A["host_vars"] --> B["Host A overrides"] - A --> C["Host B overrides"] - A --> D["Per-node secrets or tuning"] + A["host_vars"] + click A href "./" "host_vars" ``` ## Notes diff --git a/infra-run/ansible/playbooks/README.md b/infra-run/ansible/playbooks/README.md index 9281ecc..16b2d91 100644 --- a/infra-run/ansible/playbooks/README.md +++ b/infra-run/ansible/playbooks/README.md @@ -6,10 +6,8 @@ This directory is intended for executable Ansible playbooks that coordinate role ```mermaid flowchart TD - A["playbooks"] --> B["Provisioning flows"] - A --> C["Hardening flows"] - A --> D["Patch workflows"] - A --> E["Decommission workflows"] + A["playbooks"] + click A href "./" "playbooks" ``` ## Notes diff --git a/infra-run/ansible/roles/README.md b/infra-run/ansible/roles/README.md index 9e3c05a..9375149 100644 --- a/infra-run/ansible/roles/README.md +++ b/infra-run/ansible/roles/README.md @@ -6,10 +6,8 @@ This folder is reserved for reusable Ansible roles. Roles make it possible to or ```mermaid flowchart TD - A["roles"] --> B["common"] - A --> C["monitoring"] - A --> D["storage"] - A --> E["security"] + A["roles"] + click A href "./" "roles" ``` ## Notes diff --git a/infra-run/ansible/tests/README.md b/infra-run/ansible/tests/README.md index a3fb780..5a29a95 100644 --- a/infra-run/ansible/tests/README.md +++ b/infra-run/ansible/tests/README.md @@ -6,9 +6,8 @@ This directory is reserved for validation of Ansible content. It represents the ```mermaid flowchart TD - A["tests"] --> B["Syntax checks"] - A --> C["Molecule or scenario tests"] - A --> D["Post-run validation"] + A["tests"] + click A href "./" "tests" ``` ## Notes diff --git a/infra-run/docs/README.md b/infra-run/docs/README.md index bc492a9..d3d41c1 100644 --- a/infra-run/docs/README.md +++ b/infra-run/docs/README.md @@ -6,9 +6,8 @@ This directory is intended for supporting technical documentation tied to the op ```mermaid flowchart TD - A["docs"] --> B["Architecture notes"] - A --> C["Operational references"] - A --> D["Change preparation notes"] + A["docs"] + click A href "./" "docs" ``` ## Notes diff --git a/infra-run/runbooks/README.md b/infra-run/runbooks/README.md index 1f72b09..5f9dbf8 100644 --- a/infra-run/runbooks/README.md +++ b/infra-run/runbooks/README.md @@ -6,10 +6,8 @@ This directory is reserved for runbook-style procedures that describe how to per ```mermaid flowchart TD - A["runbooks"] --> B["Pre-check"] - A --> C["Change execution"] - A --> D["Post-check"] - A --> E["Rollback or escalation"] + A["runbooks"] + click A href "./" "runbooks" ``` ## Notes diff --git a/infra-run/scripts/README.md b/infra-run/scripts/README.md index fd6b0e3..8a9a4f1 100644 --- a/infra-run/scripts/README.md +++ b/infra-run/scripts/README.md @@ -6,10 +6,10 @@ This directory groups executable tooling used across the `infra-run` project. It ```mermaid flowchart TD - A["scripts"] --> B["bash"] - A --> C["python"] - B --> D["Operational toolkits"] - C --> E["Future helper utilities"] + A["scripts"] --> B["bash"] --> C["python"] + click A href "./" "scripts" + click B href "./bash/" "bash" + click C href "./python/" "python" ``` ## Scope diff --git a/infra-run/scripts/bash/README.md b/infra-run/scripts/bash/README.md index da1bb12..32b4543 100644 --- a/infra-run/scripts/bash/README.md +++ b/infra-run/scripts/bash/README.md @@ -6,14 +6,12 @@ Small, practical Bash scripts for Linux operations checks and incident triage. T ```mermaid flowchart TD - A["bash"] --> B["os-healthcheck"] - A --> C["disk-full"] - A --> D["veritas"] - A --> E["gpfs"] - B --> B1["Host diagnostics"] - C --> C1["Incident workflow"] - D --> D1["VxVM and VCS change flow"] - E --> E1["Spectrum Scale expansion flow"] + A["bash"] --> B["os-healthcheck"] --> C["disk-full"] --> D["veritas"] --> E["gpfs"] + click A href "./" "bash" + click B href "./os-healthcheck/" "os-healthcheck" + click C href "./disk-full/" "disk-full" + click D href "./veritas/" "veritas" + click E href "./gpfs/" "gpfs" ``` ## Scripts diff --git a/infra-run/scripts/bash/disk-full/README.md b/infra-run/scripts/bash/disk-full/README.md index b6e9e4c..4315cb2 100644 --- a/infra-run/scripts/bash/disk-full/README.md +++ b/infra-run/scripts/bash/disk-full/README.md @@ -6,14 +6,8 @@ Production-style Bash toolkit for diagnosing and handling a disk full incident o ```mermaid flowchart TD - A["disk-full"] --> B["01_disk_overview.sh"] - A --> C["02_find_big_files.sh"] - A --> D["03_deleted_open_files.sh"] - A --> E["04_top_dirs.sh"] - A --> F["05_log_cleanup.sh"] - A --> G["06_quick_fix.sh"] - A --> H["07_postcheck.sh"] - A --> I["disk_full_runbook.sh"] + A["disk-full"] + click A href "./" "disk-full" ``` ## Why Disk Full Incidents Happen diff --git a/infra-run/scripts/bash/gpfs/README.md b/infra-run/scripts/bash/gpfs/README.md index 0249b27..5d61df7 100644 --- a/infra-run/scripts/bash/gpfs/README.md +++ b/infra-run/scripts/bash/gpfs/README.md @@ -8,15 +8,8 @@ These scripts are examples. Exact GPFS commands, flags, quorum practices, failur ```mermaid flowchart TD - A["gpfs"] --> B["01_cluster_overview.sh"] - A --> C["02_precheck_gpfs.sh"] - A --> D["03_detect_new_disks.sh"] - A --> E["04_create_nsd_stanza.sh"] - A --> F["05_add_nsd_to_filesystem.sh"] - A --> G["06_rebalance_filesystem.sh"] - A --> H["07_postcheck_gpfs.sh"] - A --> I["08_generate_report.sh"] - A --> J["gpfs_extend_runbook.sh"] + A["gpfs"] + click A href "./" "gpfs" ``` ## Concepts diff --git a/infra-run/scripts/bash/os-healthcheck/README.md b/infra-run/scripts/bash/os-healthcheck/README.md index 02c4bf4..b0efdc3 100644 --- a/infra-run/scripts/bash/os-healthcheck/README.md +++ b/infra-run/scripts/bash/os-healthcheck/README.md @@ -6,11 +6,8 @@ This directory contains first-pass Linux diagnostics for common host checks. The ```mermaid flowchart TD - A["os-healthcheck"] --> B["healthcheck.sh"] - A --> C["disk_check.sh"] - A --> D["service_check.sh"] - A --> E["system_report.sh"] - A --> F["network_troubleshoot.sh"] + A["os-healthcheck"] + click A href "./" "os-healthcheck" ``` ## Scripts diff --git a/infra-run/scripts/bash/veritas/README.md b/infra-run/scripts/bash/veritas/README.md index 3b69b65..9b8168a 100644 --- a/infra-run/scripts/bash/veritas/README.md +++ b/infra-run/scripts/bash/veritas/README.md @@ -6,15 +6,8 @@ Production-style Bash examples for expanding storage in a Veritas environment. T ```mermaid flowchart TD - A["veritas"] --> B["01_detect_new_luns.sh"] - A --> C["02_precheck_vcs_vxvm.sh"] - A --> D["03_freeze_vcs_group.sh"] - A --> E["04_init_vxvm_disks.sh"] - A --> F["05_extend_diskgroup.sh"] - A --> G["06_extend_volume_fs.sh"] - A --> H["07_postcheck_vcs_vxvm.sh"] - A --> I["08_unfreeze_vcs_group.sh"] - A --> J["veritas_extend_runbook.sh"] + A["veritas"] + click A href "./" "veritas" ``` ## VxVM vs VCS diff --git a/infra-run/scripts/python/README.md b/infra-run/scripts/python/README.md index fcff147..03f40c1 100644 --- a/infra-run/scripts/python/README.md +++ b/infra-run/scripts/python/README.md @@ -6,9 +6,8 @@ This directory is reserved for Python helpers that may later complement the Bash ```mermaid flowchart TD - A["python"] --> B["Future reporting utilities"] - A --> C["Parsers"] - A --> D["Automation helpers"] + A["python"] + click A href "./" "python" ``` ## Notes diff --git a/labs/README.md b/labs/README.md index ea430d0..0b16710 100644 --- a/labs/README.md +++ b/labs/README.md @@ -6,11 +6,13 @@ This directory collects hands-on lab areas used for experimentation and skill de ```mermaid flowchart TD - A["labs"] --> B["docker"] - A --> C["kubernetes"] - A --> D["terraform"] - A --> E["networking"] - A --> F["ci-cd"] + A["labs"] --> B["docker"] --> C["kubernetes"] --> D["terraform"] --> E["networking"] --> F["ci-cd"] + click A href "./" "labs" + click B href "./docker/" "docker" + click C href "./kubernetes/" "kubernetes" + click D href "./terraform/" "terraform" + click E href "./networking/" "networking" + click F href "./ci-cd/" "ci-cd" ``` ## Scope diff --git a/labs/ci-cd/README.md b/labs/ci-cd/README.md index ea8be44..ba4ed23 100644 --- a/labs/ci-cd/README.md +++ b/labs/ci-cd/README.md @@ -6,10 +6,8 @@ This folder is intended for CI/CD experiments such as pipeline layouts, validati ```mermaid flowchart TD - A["ci-cd"] --> B["Build"] - A --> C["Test"] - A --> D["Package"] - A --> E["Deploy"] + A["ci-cd"] + click A href "./" "ci-cd" ``` ## Notes diff --git a/labs/docker/README.md b/labs/docker/README.md index 9b7c926..3134124 100644 --- a/labs/docker/README.md +++ b/labs/docker/README.md @@ -6,9 +6,8 @@ This folder is reserved for Docker-focused lab work. It is intended for image bu ```mermaid flowchart TD - A["docker"] --> B["Dockerfiles"] - A --> C["Compose stacks"] - A --> D["Container debugging"] + A["docker"] + click A href "./" "docker" ``` ## Notes diff --git a/labs/kubernetes/README.md b/labs/kubernetes/README.md index 9484e46..db1d2d8 100644 --- a/labs/kubernetes/README.md +++ b/labs/kubernetes/README.md @@ -6,10 +6,8 @@ This folder is intended for Kubernetes lab work such as manifests, troubleshooti ```mermaid flowchart TD - A["kubernetes"] --> B["Workloads"] - A --> C["Services"] - A --> D["Ingress and networking"] - A --> E["Cluster troubleshooting"] + A["kubernetes"] + click A href "./" "kubernetes" ``` ## Notes diff --git a/labs/networking/README.md b/labs/networking/README.md index d16a1da..6afcc6c 100644 --- a/labs/networking/README.md +++ b/labs/networking/README.md @@ -6,10 +6,8 @@ This folder is reserved for networking-focused exercises. It can hold examples a ```mermaid flowchart TD - A["networking"] --> B["Routing"] - A --> C["DNS"] - A --> D["Firewall and ports"] - A --> E["Connectivity tests"] + A["networking"] + click A href "./" "networking" ``` ## Notes diff --git a/labs/terraform/README.md b/labs/terraform/README.md index 2c65d3f..8077389 100644 --- a/labs/terraform/README.md +++ b/labs/terraform/README.md @@ -6,9 +6,8 @@ This folder is intended for Terraform experiments and infrastructure-as-code pra ```mermaid flowchart TD - A["terraform"] --> B["Modules"] - A --> C["Environment configs"] - A --> D["Plan and apply workflows"] + A["terraform"] + click A href "./" "terraform" ``` ## Notes diff --git a/platform-projects/README.md b/platform-projects/README.md index 690be59..4eb8583 100644 --- a/platform-projects/README.md +++ b/platform-projects/README.md @@ -6,11 +6,13 @@ This directory groups broader infrastructure themes that sit above individual sc ```mermaid flowchart TD - A["platform-projects"] --> B["storage"] - A --> C["clustering"] - A --> D["monitoring-zabbix"] - A --> E["virtualization"] - A --> F["elk-log-analysis"] + A["platform-projects"] --> B["storage"] --> C["clustering"] --> D["monitoring-zabbix"] --> E["virtualization"] --> F["elk-log-analysis"] + click A href "./" "platform-projects" + click B href "./storage/" "storage" + click C href "./clustering/" "clustering" + click D href "./monitoring-zabbix/" "monitoring-zabbix" + click E href "./virtualization/" "virtualization" + click F href "./elk-log-analysis/" "elk-log-analysis" ``` ## Scope diff --git a/platform-projects/clustering/README.md b/platform-projects/clustering/README.md index daa62af..3ef4e9d 100644 --- a/platform-projects/clustering/README.md +++ b/platform-projects/clustering/README.md @@ -6,10 +6,8 @@ This folder is reserved for clustering-focused platform work. It is meant for hi ```mermaid flowchart TD - A["clustering"] --> B["Quorum"] - A --> C["Failover"] - A --> D["Service groups"] - A --> E["Operational validation"] + A["clustering"] + click A href "./" "clustering" ``` ## Notes diff --git a/platform-projects/elk-log-analysis/README.md b/platform-projects/elk-log-analysis/README.md index d3f0cc9..917df93 100644 --- a/platform-projects/elk-log-analysis/README.md +++ b/platform-projects/elk-log-analysis/README.md @@ -6,10 +6,8 @@ This folder is intended for Elastic Stack style log-analysis work. It can hold e ```mermaid flowchart TD - A["elk-log-analysis"] --> B["Ingest"] - A --> C["Parse"] - A --> D["Search"] - A --> E["Visualize"] + A["elk-log-analysis"] + click A href "./" "elk-log-analysis" ``` ## Notes diff --git a/platform-projects/monitoring-zabbix/README.md b/platform-projects/monitoring-zabbix/README.md index ca7289b..27b1176 100644 --- a/platform-projects/monitoring-zabbix/README.md +++ b/platform-projects/monitoring-zabbix/README.md @@ -6,10 +6,8 @@ This folder is reserved for monitoring and alerting work centered on Zabbix-styl ```mermaid flowchart TD - A["monitoring-zabbix"] --> B["Hosts"] - A --> C["Templates"] - A --> D["Triggers"] - A --> E["Dashboards"] + A["monitoring-zabbix"] + click A href "./" "monitoring-zabbix" ``` ## Notes diff --git a/platform-projects/storage/README.md b/platform-projects/storage/README.md index 92278d4..9503476 100644 --- a/platform-projects/storage/README.md +++ b/platform-projects/storage/README.md @@ -6,10 +6,8 @@ This folder is intended for storage-oriented platform topics. It can hold higher ```mermaid flowchart TD - A["storage"] --> B["Capacity planning"] - A --> C["Filesystem expansion"] - A --> D["Block device management"] - A --> E["Operational safety"] + A["storage"] + click A href "./" "storage" ``` ## Notes diff --git a/platform-projects/virtualization/README.md b/platform-projects/virtualization/README.md index 4ac4d66..24b554c 100644 --- a/platform-projects/virtualization/README.md +++ b/platform-projects/virtualization/README.md @@ -6,10 +6,8 @@ This folder is reserved for virtualization platform topics. It is intended for w ```mermaid flowchart TD - A["virtualization"] --> B["Hypervisors"] - A --> C["Guests"] - A --> D["Resource planning"] - A --> E["Operational maintenance"] + A["virtualization"] + click A href "./" "virtualization" ``` ## Notes