MakerFLOSS/scripts/overview_config.yml

39 lines
1.2 KiB
YAML
Raw Normal View History

# Configuration for scripts/gen_overview.py
#
# Each top-level key is a category. The generator is invoked with
# --category <name> and looks up its block here. To add a new category
# (services, vms, ...) later, copy a block and adjust the fields.
hardware:
title: "Hardware Overview"
source_dir: docs/hardware
output_file: docs/hardware/index.md
required_fields:
- hostname
- kind
- status
enums:
kind: [server, laptop, sbc, switch, ap, desktop]
status: [in-use, staging, spare, broken, donated]
storage_type: [nvme, ssd, hdd, mixed]
group_by: kind
# Human-friendly H2 names per group_by value. Anything missing falls back
# to the raw value title-cased + "s".
group_titles:
server: Servers
laptop: Laptops
sbc: Single-board computers
switch: Switches
ap: Access points
desktop: Desktops
sort_by: hostname
columns:
- { header: Hostname, kind: hostname-link }
- { header: Model, field: model }
- { header: Location, field: location }
- { header: CPU, kind: cpu }
- { header: RAM, kind: ram }
- { header: Storage, kind: storage }
- { header: NIC, kind: nic }
- { header: Status, field: status }