It’s also good to make notes on every configuration setting.
I do save my settings for the various programs in a git repository…
Comment on How do you document your Homelab?
LastYearsIrritant@sopuli.xyz 2 weeks agoThere’s no such thing as too simple to document. If you spent time learning how to install it, you’ll need to relearn it if you want to make any changes in the future. If you don’t leave at least some notes as to why you make some decisions, you’ll have to redo your work.
It’s also good to make notes on every configuration setting. That forces you to understand why the settings are the way they are. If you have a -f in a docker config and you don’t have any understanding of why that’s there, you might not know if it’s a development flag for getting things set up, or if it’s a critical part of your environment.
It is especially important if any of those parts are exposed to the public Internet. You might have a config set to allow unauthenticated connections and not know it.
It’s also good to make notes on every configuration setting.
I do save my settings for the various programs in a git repository…
CapitalNumbers@lemm.ee 2 weeks ago
i mean charitably you could say that your code / architecture should be self documenting, versus having to rely on READMEs / wikis
in effect, if you change the code you are by definition also changing the documentation, since the file names/function names/hierarchy is clear and unambiguous