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.

  • hellmo_luciferrari@lemmy.zipOPEnglish
    1·
    4 hours ago

    I am leaning that way too. Although I do want to maintain a wiki that I can host.

    So I settled on using a script that runs as a service on a timer, and can beanually triggered to generate README.md files that get synced with my git repo of docker containers

    This will be huge for me, as most of what I run are containers.

    The next step will be using Bookstack’s API to push these README.md files into books on my bookstack container.

    I’ll go a step further and setup automated exports of these documents.