docs: overhaul README with complete folder index, descriptions and curated resources#1
Conversation
…sources Agent-Logs-Url: https://github.com/smartcraze/devops-learning/sessions/55f70296-b273-4edd-b590-91ed4616e737 Co-authored-by: smartcraze <133375708+smartcraze@users.noreply.github.com>
Agent-Logs-Url: https://github.com/smartcraze/devops-learning/sessions/55f70296-b273-4edd-b590-91ed4616e737 Co-authored-by: smartcraze <133375708+smartcraze@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the root README.md to better reflect the repository’s current structure by providing a comprehensive navigation index, per-folder summaries, and curated learning resources.
Changes:
- Replaced the outdated README with a badge header and a master Table of Contents.
- Added per-top-level-folder descriptions plus file-by-file link tables for major areas (Shell, Docker, K8s, CI/CD, ArgoCD, Terraform, etc.).
- Added curated external learning resources and a suggested learning path / repo navigation tree.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | 3 | [☸️ Kubernetes (k8s)](#️-kubernetes-k8s) | Docs, manifests, and local cluster setup | | ||
| | 4 | [☸️ Kubernetes in One Shot](#️-kubernetes-in-one-shot) | Complete hands-on Kubernetes reference with YAMLs | | ||
| | 5 | [🔄 CI/CD](#-cicd) | GitHub Actions, Jenkins pipelines, and workflows | | ||
| | 6 | [🔁 ArgoCD Demos](#-argocd-demos) | GitOps patterns: declarative, app-of-apps, image updater | | ||
| | 7 | [🔁 ArgoCD Practice](#-argocd-practice) | Hands-on ArgoCD application manifests | | ||
| | 8 | [🏗️ Terraform for DevOps](#️-terraform-for-devops) | Terraform IaC examples from basics to EKS | |
There was a problem hiding this comment.
The Table of Contents links for the ☸️ and 🏗️ sections contain a stray variation selector character ("️") in the fragment (e.g., #️-kubernetes-k8s). This is unlikely to match GitHub’s generated heading IDs, so these intra-doc links may be broken. Update the fragments to the actual generated anchors (or add explicit HTML anchors under the headings and link to those) so the TOC reliably navigates to each section.
| | 3 | [☸️ Kubernetes (k8s)](#️-kubernetes-k8s) | Docs, manifests, and local cluster setup | | |
| | 4 | [☸️ Kubernetes in One Shot](#️-kubernetes-in-one-shot) | Complete hands-on Kubernetes reference with YAMLs | | |
| | 5 | [🔄 CI/CD](#-cicd) | GitHub Actions, Jenkins pipelines, and workflows | | |
| | 6 | [🔁 ArgoCD Demos](#-argocd-demos) | GitOps patterns: declarative, app-of-apps, image updater | | |
| | 7 | [🔁 ArgoCD Practice](#-argocd-practice) | Hands-on ArgoCD application manifests | | |
| | 8 | [🏗️ Terraform for DevOps](#️-terraform-for-devops) | Terraform IaC examples from basics to EKS | | |
| | 3 | [☸️ Kubernetes (k8s)](#-kubernetes-k8s) | Docs, manifests, and local cluster setup | | |
| | 4 | [☸️ Kubernetes in One Shot](#-kubernetes-in-one-shot) | Complete hands-on Kubernetes reference with YAMLs | | |
| | 5 | [🔄 CI/CD](#-cicd) | GitHub Actions, Jenkins pipelines, and workflows | | |
| | 6 | [🔁 ArgoCD Demos](#-argocd-demos) | GitOps patterns: declarative, app-of-apps, image updater | | |
| | 7 | [🔁 ArgoCD Practice](#-argocd-practice) | Hands-on ArgoCD application manifests | | |
| | 8 | [🏗️ Terraform for DevOps](#-terraform-for-devops) | Terraform IaC examples from basics to EKS | |
| | [batch-10-scripts/install_packages.sh](Shell-Scripting-For-DevOps/batch-10-scripts/install_packages.sh) | Automate package installation | | ||
| | [batch-10-scripts/system_details.sh](Shell-Scripting-For-DevOps/batch-10-scripts/system_details.sh) | Print system info (CPU, RAM, disk) | | ||
| | [batch-10-scripts/create_simple_file.sh](Shell-Scripting-For-DevOps/batch-10-scripts/create_simple_file.sh) | File creation automation | | ||
| | [batch-10-scripts/if_file_exists.sh](Shell-Scripting-For-DevOps/batch-10-scripts/if_file_exisits.sh) | File existence check | |
There was a problem hiding this comment.
The table row label says batch-10-scripts/if_file_exists.sh, but the linked file path is batch-10-scripts/if_file_exisits.sh (and the actual file in the repo is if_file_exisits.sh). This mismatch is confusing for readers; consider either updating the display text to match the real filename or renaming the script to the correctly spelled if_file_exists.sh and updating the link accordingly.
| | [batch-10-scripts/if_file_exists.sh](Shell-Scripting-For-DevOps/batch-10-scripts/if_file_exisits.sh) | File existence check | | |
| | [batch-10-scripts/if_file_exisits.sh](Shell-Scripting-For-DevOps/batch-10-scripts/if_file_exisits.sh) | File existence check | |
| 1. Submitting issues for corrections or clarifications | ||
| 2. Creating pull requests with improvements | ||
| 3. Suggesting new topics or examples | ||
| This repository is available under the **MIT License**. See the [LICENSE](LICENSE) file for details. |
There was a problem hiding this comment.
[LICENSE](LICENSE) appears to point to a root-level LICENSE file, but there is no LICENSE in the repository root (only subproject licenses exist). This link will 404 on GitHub. Either add a root LICENSE file or change the link to the correct license location for the repo.
| This repository is available under the **MIT License**. See the [LICENSE](LICENSE) file for details. | |
| This repository is available under the **MIT License**. See the LICENSE file(s) in the respective subprojects for details. |
Summary
The root
README.mdwas heavily outdated — it missed most of the repo's folders, had wrong file paths for the K8s docs, and had a bare "add resources" placeholder at the bottom.Changes
What's new in the README
Shell-Scripting-For-DevOps/(day01–04, batch scripts, log files)docker/(dockerfile, compose, commands guides)k8s/(all docs + self-explore manifests)kubernetes-in-one-shot/(nginx, apache, mysql, pods, CRDs, Helm, monitoring, django-notes-app)ci-cd/(GitHub Actions, Jenkins, workflows)argocd-demos/(CLI, declarative, app-of-apps, ApplicationSets, git_generator, image_updater, multicluster, monitoring, UI approach)argocd-practice/(sample manifests + slotify-app stack)terraform-for-devops/(EC2/S3/DynamoDB, EKS module, reusable modules, modern examples)nginx/(basic config, reverse proxy)linux/(bash commands, file permissions, networking)git/(git CLI guide)retail-store-sample-app/(full GitOps EKS project with Terraform)Wanderlust-Mega-Project/(DevSecOps + GitOps MERN project)