Skip to main content

Tagging & Categories Guidelines

Purpose: provide a small, canonical taxonomy for your Homelab docs so tags and categories are consistent across repos.

Categories (primary content types):

  • inventory – hosts, VMs, hardware records
  • service – documentation for services (Plex, Gitea, Nextcloud)
  • runbook – operational runbooks and maintenance steps
  • incident – RCA and incident reports
  • architecture – design and topology docs

Recommended tags (examples):

  • Functional groups: media, infrastructure, monitoring, security, backup, networking
  • Service-specific: plex, sonarr, radarr, gitea, nextcloud, traefik, nginx
  • Environment/role: prod, test, edge, offsite
  • Technical: docker, linux, systemd, backup, automation

Tag rules:

  • Use lowercase and hyphens. Example: game-server, not gamesrv.
  • Keep tags short and service-focused.
  • Add homelab tag for posts you want in the central HomeLab listing (optional if you prefer sub-tag-only listings).

How to use archetypes:

  • Create a new host: hugo new --kind host inventories/hosts/my-host.md (uses archetypes/host.md)
  • Create a new service: hugo new --kind service docs/services/my-service.md
  • Create a runbook: hugo new --kind runbook runbooks/my-runbook.md
  • Create an incident: hugo new --kind incident runbooks/incidents/rca.md

Notes:

  • I did not change the Homelab-Doc repo; these templates live in skui.io for new content authored in the Hugo site.
  • If you want, I can create a small script to suggest tag mappings for existing Homelab-Doc files.
Steffen Skui
Author
Steffen Skui
Working in IT in the private sector, spending free time on automation, self-hosted services, and small homelab experiments. Father of two.