• 1 Post
  • 8 Comments
Joined 2 months ago
cake
Cake day: March 23rd, 2025

help-circle

  • Here’s my approach to documentation. It’s about habits as much as it’s about actually writing anything down:

    1. Never setup anything important via naked terminal commands that you will forget you did

    2. Always wrap important commands in some kind of “setup-xyz.sh” script and then run that script to see if your install worked.

    3. If you need to make a change to your service, ensure you update your script and so it can be re-run without braking anything

    Get into the habit of this and you are documenting as you go


  • i second this

    i haven’t gotten around to looking into something like terraform/ansible yet, and currently rely on a series of setup.sh scripts and docker-compose files

    i have a single master setup.sh at the root of my homelab which basically just outlines which scripts i need to run and in what order in order to get things back up and running from zero

    i only user my README.md for any non scriptable stuff (such as external services i rely on such as cloudflare/vpn providers, etc)