Decide what `v1.0.0` requires

Abierto
  • ¿Algo no está bien?
#136 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
5/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Activo
Stack tecnológico
git
Área
release

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
0
Forks
0
Merge medio
6 h 14 min
PR fusionados (30 d)
27

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de AbsaOSS/living-doc

Todos los issues de AbsaOSS/living-doc

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.