Skip to content

What do you use for documentation that doesn't rot?

General Discussion by olespete 4 replies 199 views
14 #1

Our internal wiki on BookStack has become a graveyard. Last updated 2021, full of dead links, credentials for decommissioned hosts, procedures that don't match current iptables rules. What do you use that doesn't rot? I need something that survives staff turnover and doesn't become a security liability—old docs with old firewall configs are WORSE than no docs!

airgapped, encrypted, faraday'd, still worried
4 #2

Bookstack rots because
It wants you to click
Clicking rots
git with markdown
Never rots
Ci publishes
Flat html
No database
No rot
I use mkdocs
Tab indented
Every source file

3 #3

Hey folks, friendly reminder that this isn't a vs. Thread yet, but it might become one.

I've seen Outline work well for teams that need permissions without Git complexity. But the "doesn't rot" requirement usually points to version control somewhere in the stack.

~be kind or be gone~
#4

1. BookStack: pretty, rots fast
2. Outline: good permissions, still a database
3. GitBook: vendor lock-in, they changed pricing twice
4. Markdown in Git:
A) version history for free
B) ci publishes to static site
C) no database to corrupt
D) roman numerals optional
5. I moved my homelab to MkDocs with GitHub Actions, zero rot since 2019

#5

Verify your restores weekly

I had beautiful confluence docs. Restore from backup, it's 2022 content. Nobody checked. The live site had "improvements" not in git. Disaster. Markdown in git with CI is the only way I sleep now. But verify your CI publish actually runs. I have seen CI green but s3 empty. Verify your restores.

Post a reply

You need an account to reply. Log in or register to join the conversation.

Post reply Preview Save draft