Comment on Homelab Documentation

StripedMonkey@lemmy.zip ⁨3⁩ ⁨hours⁩ ago

Traditionally I open a README.md in the dir the application lives in after I configure something I will open my browser history, and dump every link I clicked into the file.

I then copy paste a choice selection of my shell history into the file.

This is the bare minimum. It’s easy to do, takes like 5 minutes, and you will be happy to have it in 8 months. I would make the argument that anyone who tells you to do anything else can suck it. Do the readme first, any “better” documentation second.

Getting Into the habit of doing this matters more than a good documentation system. You will be lazy and try to get around to documenting something later. Don’t let it be later. Shitty link dumps are still gold mines for your future self

original
Sort:hotnewtop