🔥Challenge Series #3: Document your Home Lab!

Jul 7 (edited) • Challenges

Challenge 3: Document Your Home Lab in Git

Repository: https://github.com/brandonleegit/homelabexplorers.git

Folder: challenges/<your-github-username>-challenge3/

⚠️ IMPORTANT: Do not commit any sensitive information—redact or anonymize IP addresses, hostnames, credentials, keys, or any other secrets before you push your changes.

What to Do

Clone the Repo - git clone https://github.com/brandonleegit/homelabexplorers.git
cd homelabexplorers

Create a New Branch

git checkout -b docs/home-lab-inventory
Create Your Challenge Folder under the root /challenges folder
mkdir -p challenges/$(git config user.username)-challenge3

cd challenges/$(git config user.username)-challenge3
Add Your Documentation

Hardware Inventory (hardware.md)

List each device (e.g., “Server-1: Dell R420, 2×E5-2650, 64 GB, 4 × 4 TB”, IP: 10.1.X.X – redact last octet).

Network Topology (network.md)

Describe VLANs, subnets, uplinks. Redact exact IPs (e.g., 192.168.1.X). Optionally include an ASCII or PlantUML diagram.

Services & Workloads (services.md)

Catalog VMs, containers, clusters, key apps (e.g., “Prometheus on VM-2, Gitea on container-1”).
Configuration Snippets (configs/)

Add sanitized versions of critical .yml or .conf files (e.g., remove API keys, passwords).

Stage & Commit

git add challenges/$(git config user.username)-challenge3

git commit -m "docs: add home-lab documentation for Challenge 3"

Push & Open a PR

git push origin docs/home-lab-inventory
Then open a pull request against main.

Share Your Submission

Post the PR link (or the commit SHA) back in the “Challenges” thread.
Call out one tricky part you documented (e.g., your VLAN tagging approach or a custom storage config).

2 comments