Comment

Comment on **How** should I properly document my homelab?

enchantedgoldapple@sopuli.xyz ⁨23⁩ ⁨hours⁩ ago

Thanks for your response. I already have Joplin synced with my server as a solution for my documentation. However I meant to ask how you structure your documentation, know what and how to mention, and organise it for future reference.

source

Sort:hotnew top

unimalion@sh.itjust.works ⁨20⁩ ⁨hours⁩ ago
Don’t know if this helps since dokuwiki lets me link pages, but I have a main page where I just do a one paragraph description of every big thing in use.

each page has:

an in depth description,

how it’s set up,

a list of features i use,

how it connects to other services,

and a miscellaneous for everything else

I’ll also add any notes in the misc section in case I need to reference them later. If a service is mentioned, I’ll create a page for it and link to it every time I mention it. That way nothing is more than a few clicks away and the documentation grows naturally as long as you don’t have any monolithic application. Example: (main -> Docker -> Project_Ozone_2 -> custom configurations Or main -> Joomla -> wysiwyg ->JCE Editor)

I also had a professor tell me to just write everything down first and then focus on formatting to find what kind of structure suits your needs best.
source