Looking for tech documentation solution

3 years ago by plasticus to c/selfhost

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?

load all comments
transporteraccident1 1 point 3 years ago

I know this is the self-hosted Community, but I would use GitHub for that use case. I like to keep notes and links in plaintext files, and then store those instruction documents together in a project with any files needed for the project (like config files), that can then ask be easily pulled to the device you're working on. You can also get fancy and store the instructions in batch files that actually carry out the steps for you.

Of course something very similar could be achieved with a self-hosted git instance, but I like using GitHub because I like having the web interface and Pages option when those are relevant.

path: 0 579962, hotness: undefined, score: 1, children: 0
selfhost
selfhost

@lemmy.ml

login for more options
21214
570
246

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

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

Cross-posting

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

go to feed...