Ask HN: How do you document a server?

https://news.ycombinator.com/item?id=13616291

by rxlim • 9 years ago

1 2 9 years ago

news.ycombinator.com

  - Do you describe all steps from OS installation to application setup?
  - What do you use to create the documentation?
  - Where do you store the documentation?

Any information related to server documentation is relevant.

savethefuture• 9 years ago

Recently, I've been wanting to document how I setup my servers. I would start from a blank slate base linux install and go from there, listing each command I run and what it does. Then building off each command into the next leading the reader through the steps of configuration and installation of software. This is all for a blog, so take that into consideration.

snowcrshd• 9 years ago

Hmm, interesting question. I'd like to know how other people do it.

At work, we generally don't write narrative documentation for server setup. It requires quite the effort to make sure it doesn't go stale.

Instead, we keep Ansible playbooks on a Git repository. Every change we make to the server setup is done through the playbooks. Git commits provide a history of the changes made (we usually write the why in the long commit message).

Usually just having a README with information on how to run the playbooks and which distro the playbooks are based on is enough.

Ask HN: How do you document a server?

Related Stories