Greetings Lemmings,
I realize that self-hosting for many is just a hobby. Something they do for fun. And the topic of today is usually a “not-so-fun” part of the IT industry.
Jump Scare Warning
Documentation
I have for so long just let my lab grow organically. And months down the road an issue pops up with a service, and I have no idea how I set something up, and may not have documented it. Whether that be comments inside of configuration files, or via other means.
I have gotten marginally better at documenting within the config files or code that I am writing. However, I don’t want just that as an option. So I spun myself up a Bookstack container.
I am slowly going through and creating what would amount to a full blown wiki for my setup. Doubly I can use this as part of my resume.
So I ask of you; what ways do you prefer to document? How do you keep yourself honest, and actually stick to it.
Edit: I created bash scripts that are run by a systemd service and timer. At least for my docker box.
I just break things enough times until I internalize the knowledge into my soul.
Kidding aside, I do wish I was more disciplined about documentation.
It could have really helped me earlier in the week in fact. I figured out something really clever a couple of months ago, promptly wiped the computer. And now I can’t recreate it. I’ve come up with a halfway solution, but it’s not as elegant as it used to be.
To be honest with you, this is a really good use case for a large language model - self hosted or other wise. You know Karpathy’s LLM-wiki method?
I dont but I am interestes in learning something new
Here’s the OG
https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f
And the clanker write up https://blog.starmorph.com/blog/karpathy-llm-wiki-knowledge-base-guide
Thank you!
Hope it helps!