Add repository documentation: README, CONTRIBUTING.md, and docs/#30
Open
Add repository documentation: README, CONTRIBUTING.md, and docs/#30
Conversation
Co-authored-by: ksobrenat32 <71863693+ksobrenat32@users.noreply.github.com> Agent-Logs-Url: https://github.com/LIDSOL/infra/sessions/80f70b93-ff0c-42bb-83cd-caa9a629192a
Copilot
AI
changed the title
[WIP] Add documentation for the entire repository
Add repository documentation: README, CONTRIBUTING.md, and docs/
Mar 21, 2026
Member
|
what do you think? @LuisDakan @Morall0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No top-level README, contribution guide, or structured documentation existed for this infrastructure repo.
Changes
README.md— Project overview with architecture ASCII diagram, repo structure tree, prerequisites table, and quick-start commands for cluster provisioning, public-server setup, and GitOps.CONTRIBUTING.md— Contribution workflow covering: dev environment setup, Ansible idempotency/vault/lint guidance, Kubernetes manifest conventions (resource limits, cert-manager TLS, MetalLB annotations), Conventional Commits spec, and PR review requirements.docs/cluster.md— K3s provisioning sequence (node.yml→ k3s deploy →argocd.yml), node inventory, key variables (CNI, MetalLB pool, Kube-vip VIP), Longhorn storage, and troubleshooting.docs/gitops.md— ArgoCD auto-sync/prune/self-heal configuration, inventory of all deployed apps (website, Nextcloud, cert-manager, ingress-nginx, DrawDB, Speedtest), adding new apps, and TLS/Ingress patterns.docs/public-server.md— Covers all four Ansible roles: security hardening (SSH key-only, unattended-upgrades), network tuning (sysctl/irqbalance), Nginx + Certbot, and router setup (Netplan, nftables, DNSmasq, WireGuard).docs/mirrors.md— Hosted distributions table (AlmaLinux, ArchLinux, Debian/ftpsync, Fedora, Linux Mint), role structure, per-distro sync tooling, rsync daemon, and a step-by-step guide for onboarding a new mirror.🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.