Support-tier vocabulary: release pages use five values, the Board Support Rules define four different ones

Aperta
#995 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Read the Board Support Rules and the homepage’s “Which hardware is supported?” section, then compare their labels with the “Board status changes” sections in docs/releases/*.md. The issue also points to scripts/generate-release-doc.py in armbian/armbian.github.io for how release labels are produced. Done means the open vocabulary questions have human decisions and the homepage explanation matches the agreed terminology.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Blocking a homepage cleanup: the homepage explains three support tiers, generated release pages emit five different labels, and User-Guide_Board-Support-Rules.md — the source of truth — defines a fourth set. A reader who lands on /releases/26.8/ and sees

panther-x2: Standard support → EOS

has no way to map that onto the three buttons the homepage explains.

I stopped rather than invent definitions, per the brief. This needs a human decision before the homepage section can be rewritten.

Every distinct value found in generated release pages

From the "Board status changes" section of docs/releases/*.md (25.2 → 26.8). The generator (scripts/generate-release-doc.py in armbian/armbian.github.io) derives these from the config/boards/<board>.<ext> file extension in armbian/build:

Label rendered config/boards extension Boards on that extension today (armbian/build@79a3cc4) Defined in Board Support Rules?
Standard support .conf 142 ✅ Yes — "Standard Support"
CSC .csc 216 ⚠️ Only historically — named as a former status folded into "Community maintained"
EOS .eos 31 ⚠️ Only historically — same sentence
WIP .wip 0 ⚠️ Indirectly — the page calls this tier "Staging" and mentions WIP only in prose
TV box .tvb 14 ❌ Not defined anywhere. The FAQ discusses TV boxes, but not as a support tier

The three vocabularies, side by side

Homepage (/) Board Support Rules Generated release pages
Platinum Support Platinum Support (never appears)
Standard Support Standard Support Standard support
Community maintained Community maintained CSC, EOS
(absent) Staging WIP
(absent) (absent) TV box

What needs deciding

  1. TV box / .tvb has no definition at all. Is it a support tier, or a hardware category that happens to share the extension slot? Either it gets a section in the Board Support Rules, or the release generator should stop rendering it as a tier.
  2. CSC and EOS are live values, not historical ones. The Rules page says "Community maintained ... represents combined former CSC ... and EOS", but armbian/build still has 216 .csc and 31 .eos board files and the generator still emits both labels distinctly. Either the Rules page is out of date, or the generator should collapse both to "Community maintained".
  3. WIP vs Staging. Same tier, two names. Pick one for both places.
  4. Platinum Support appears on the homepage and in the Rules but has no config/boards extension, so it can never show up in a release page. Worth saying so explicitly on the homepage.

Once decided

The homepage "Which hardware is supported?" section should be updated to match the Rules page and cross-link to it, so the release pages' vocabulary is reachable from the tier explanation. That is a small follow-up PR — it just needs the answers above first.

/cc @armbian/documentation

Lingua principale
Python
Stelle
237
Fork
210
Merge medio
2h 58m
PR unite (30g)
117

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di armbian/documentation

Tutte le issue di armbian/documentation

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.