Add 'Tested on' sections to all installation documentation #107

Closed
opened 2025-09-05 14:08:10 +02:00 by michael · 1 comment
Owner

Purpose

Provide transparency about platform/version coverage for all installation guides.

Implementation Pattern

furt Installation.md

Add section:

## Tested Platforms

### Officially Supported
- OpenBSD 7.5, 7.6 (walter, wilhelm, werner2)
- Debian 12 (oldstable), 13 (stable) (johann, herbert)
- FreeBSD 13.x, 14.x (franz, otto)
- Arch Linux (rolling) (klaus)

### Package Requirements
- Lua 5.1 + socket, cjson, ssl/sec modules
- Platform-specific variations documented per OS

### Known Issues
- Debian 12: sudo not installed by default
- FreeBSD: pkg vs pkg_add differences
- Arch: lua51-* package naming

Article Testing Pattern

Each article gets:

## Getestet unter
- ✅ Debian 12 (bookworm/oldstable) - johann VM
- ✅ Debian 13 (trixie/stable) - herbert VM
- ❌ FreeBSD 14.1 - Paket xyz nicht verfügbar
- ⚠️ Arch Linux - Zusätzlicher Schritt erforderlich

Benefits

  • User Confidence: Clear platform support
  • Issue Prevention: Known limitations upfront
  • Testing Accountability: Forces actual multi-platform testing
  • Documentation Quality: Real-world validation

Success Criteria

  • furt Installation.md has comprehensive 'Tested on' section
  • Article template includes testing section
  • Existing articles updated with testing status
  • Testing status updated after each VM test session
  • Multi-version testing matrix implementation
  • New VM creation for coverage
## Purpose Provide transparency about platform/version coverage for all installation guides. ## Implementation Pattern ### furt Installation.md Add section: ```markdown ## Tested Platforms ### Officially Supported - OpenBSD 7.5, 7.6 (walter, wilhelm, werner2) - Debian 12 (oldstable), 13 (stable) (johann, herbert) - FreeBSD 13.x, 14.x (franz, otto) - Arch Linux (rolling) (klaus) ### Package Requirements - Lua 5.1 + socket, cjson, ssl/sec modules - Platform-specific variations documented per OS ### Known Issues - Debian 12: sudo not installed by default - FreeBSD: pkg vs pkg_add differences - Arch: lua51-* package naming ``` ### Article Testing Pattern Each article gets: ```markdown ## Getestet unter - ✅ Debian 12 (bookworm/oldstable) - johann VM - ✅ Debian 13 (trixie/stable) - herbert VM - ❌ FreeBSD 14.1 - Paket xyz nicht verfügbar - ⚠️ Arch Linux - Zusätzlicher Schritt erforderlich ``` ## Benefits - **User Confidence**: Clear platform support - **Issue Prevention**: Known limitations upfront - **Testing Accountability**: Forces actual multi-platform testing - **Documentation Quality**: Real-world validation ## Success Criteria - [ ] furt Installation.md has comprehensive 'Tested on' section - [ ] Article template includes testing section - [ ] Existing articles updated with testing status - [ ] Testing status updated after each VM test session ## Related Issues - Multi-version testing matrix implementation - New VM creation for coverage
michael added the
effort
medium
priority
medium
type
docs
labels 2025-09-05 14:08:10 +02:00
michael added this to the v0.1.2 - Gateway Basics milestone 2025-09-05 17:50:04 +02:00
Author
Owner

Dokumentation im wiki erstellt

Dokumentation im wiki erstellt
michael 2025-09-10 12:24:41 +02:00
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: DAW/furt#107
No description provided.