Looking for tech documentation solution (beehaw.org)

submitted 2 years ago by plasticus@beehaw.org to c/selfhost@lemmy.ml

2 comments fedilink hide all child comments

So I'm on the lookout for something, but I don't know how to briefly describe it. I want something to help me document various projects at work. It's not uncommon for me to spend a week setting something up, and it works for 2 years and then has a problem -- and I have to re-learn everything about it from the ground up before I can start solving it. For example, I'm setting up a new VMWare server today, and I just know I'm going to forget some of the details on it -- so I want to be able to type out some of the specs and processes, maybe use some tags, a coupel hyperlinks to more info, and be able to search for it a year from now. Does that make sense? Anybody have any suggestions?

top 2 comments

sorted by: hot top controversial new old

[-] mws@lemmy.mws.rocks 1 points 2 years ago

I just have a bunch of text files (org) and sync them on all my computers with Syncthing. Works great so far.

[-] johntash@eviltoast.org 1 points 2 years ago

Bookstack is a really nice wiki/documentation tool.

You may also like wiki.js or even just storing markdown files in a git repo. Lately I've been using Obsidian to manage some notes about servers, but am thinking of going back to bookstack to "publish" docs for others.

this post was submitted on 27 Jun 2023

1 points (100.0% liked)

Self Hosted - Self-hosting your services.

11599 readers

167 users here now

A place to share alternatives to popular online services that can be self-hosted without giving up privacy or locking you into a service you don't control.

Rules

No harassment
crossposts from c/Open Source & c/docker & related may be allowed, depending on context
Video Promoting is allowed if is within the topic.
No spamming.
Stay friendly.
Follow the lemmy.ml instance rules.
Tag your post. (Read under)

Important

Beginning of January 1st 2024 this rule WILL be enforced. Posts that are not tagged will be warned and if not fixed within 24h then removed!

Lemmy doesn't have tags yet, so mark it with [Question], [Help], [Project], [Other], [Promoting] or other you may think is appropriate.

Cross-posting

!everything_git@lemmy.ml is allowed!
!docker@lemmy.ml is allowed!
!portainer@lemmy.ml is allowed!
!fediverse@lemmy.ml is allowed if topic has to do with selfhosting.
!selfhosted@lemmy.ml is allowed!

If you see a rule-breaker please DM the mods!

founded 3 years ago

MODERATORS

Zoe8338@lemmy.ml

dogmuffins@lemmy.ml

testman@lemmy.ml