A future of documentation for Linodians

Linodians will have a large documentation section. It’s something that’s important to me. I’m hoping to carry on the days of the Linode Library and back when DigitalOcean was really investing in their docs. I see different categories to docs:

  • docs for Linodians branded tools. Think open-source projects. These might be on their own microsites though. Not sure.
  • guides for popular self-hosting software and stacks. Think of LAMP install guides, optimizing Mastodon setups, Minecraft servers, Jellyfin, Mattermost, etc.
  • System Administrator Docs. Setting up servers, security basics, understanding static networking, domains and DNS records, etc.

Some thoughts I have on how I want the docs to be built:

  1. I want the docs to be modular. I want more advanced docs to be able to link to the simple/common ones as a prerequisite.
  2. I want to have “smart” docs. I want to have the same doc covered for a few different OSs and OS versions with a drop down to switch between them. I want the docs to be able to dynamically update instructions when you’re running as root or not, for your username, etc. This will make copying and pasting instructions much more useful.

In my opinion, MDN Web Docs have become the de-facto source for HTML, CSS, and JavaScript documentation. I would love to build something similar for Linux server docs.

Thoughts? Agree or disagree? Anyone interested in helping write some docs or help with the site structure?