Decide what `v1.0.0` requires

Aperta
  • Qualcosa non va?
#136 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
5/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Attiva
Stack tecnologico
git
Ambito
release

Direzione di ricerca

This is a release-planning checklist for the owner, not a code change, so it is not a first task. Read docs/CONTEXT.md (the Conventions section on links to component pages) for background. The re-check commands in the issue show the current state of the links and page changes. Done means the owner has ticked or declined each item and planned the 1.0.0 release.

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

Descrizione

type:tech-debt
Description of Technical Debt

living-doc is at v0.1.0. Until v1.0.0 a minor may break and a patch never does. v1.0.0 comes when the owner
judges the product ready for users outside the owner's own projects; there is no fixed scope. Candidates to weigh:

  • GitHub Issues as a documentation source (epic)
  • Azure DevOps as a documentation source (epic)
  • PDF output (epic)
  • the security review
  • performance at volume
  • contract versioning with a compatibility interval (living-doc-utilities)
  • a first external user
  • links into component pages on tags. Today every link from living-doc to a page of a component stays on master
    while the ecosystem is under development (docs/CONTEXT.md § Conventions). The components link
    living-doc-utilities' rules on master while pinning a release, so a utilities page change ahead of the next
    minor makes a component's page link a rule its pinned version does not implement.
Impact of Technical Debt
  • None today; without a list, readiness is judged afresh each time.
Category

Other

Priority

Low - Nice to have

Proposed Solution

At each living-doc 0.x release the owner reviews this list, ticks or declines each item, and adds new ones. When every kept item is ticked, plan the 1.0.0 release.

Effort Estimate

Not applicable

Dependencies / Related

The three epics; the security, performance and contract-versioning issues.

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

Links still on master in a component: git grep -c -E 'living-doc-utilities/(blob|tree)/master' -- '*.md'. Pages changed since a pinned utilities release: git diff --stat v<pinned> origin/master -- docs in living-doc-utilities.

Lingua principale
Python
Stelle
0
Fork
0
Merge medio
6h 14m
PR unite (30g)
27

Preparare l'ambiente

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 AbsaOSS/living-doc

Tutte le issue di AbsaOSS/living-doc

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.