Having only "stable" and "unstable" maturity is a problem

Aperta
  • Qualcosa non va?
#556 3 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
30/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Attiva
Stack tecnologico
python
Ambito
backend

Direzione di ricerca

Start by reading the decision in openzim/cms#129 and trace the staging-to-production promotion flow that proposes changing title maturity. Define the agreed maturity states and their promotion behavior, then confirm that new titles, community uploads, and problematic recipes retain the intended review handling.

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

Descrizione

ATM, we have only stable and unstable maturity.

This is a problem because unstable maturity groups very distinct situations:

  1. new titles we've just created and want to force in staging before we've validated that the Zimfarm recipe is fine: all books must be blocked in staging until we have a stable recipe but once we promote a first book into production we usually want that next books updates goes straight to production unless there is a QA problem detected by the CM
  2. community titles which have been manually uploaded and for which we usually want a systematic review from publisher since we have no way to check a stable Zimfarm recipe produced the ZIM: we wanna review all uploads
  3. problematic zimfarm recipes for which we wanna review all books

ATM, whenever a book is promoted from staging to production the CMS automatically proposed to update title maturity to stable. This makes sense because the sheer majority of unstable titles for which a book is promoted are in fact new titles.

This is however quite "dangerous" because we rely on human decision to not forget to keep maturity to unstable for situations 2 and 3 above.

Either we revisit the decision made in https://github.com/openzim/cms/issues/129 (especially the "boolean" part) or we add a new flag.

I'm not a huge fan of having many flags, I feel like a 4 value flag makes more sense: stable, new, community, unstable. Distinction between community and unstable is not strictly mandatory since consequence will be identical (do not propose to update title maturity when promoting a book) but I feel like it brings clarity for editors regarding why a book is in a given status, avoiding to overrule the configuration only to realize we missed something.

@kelson42 WDYT?

Lingua principale
Python
Stelle
8
Fork
4
Merge medio
1g 19h
PR unite (30g)
36

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 openzim/cms

Tutte le issue di openzim/cms

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.