More than one documentation source in one pipeline run

Aperta
#117 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
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python

Direzione di ricerca

Read living-doc-utilities/docs/contracts/pipeline-rules.md first to understand the one-source-per-project rule. Then inspect normalize-docs and coverage-matrix for how inputs are handled; the proposed change also depends on a rule change in living-doc-utilities. Done means defining identity, precedence, and provenance across sources, then merging multiple sources in both toolkit components.

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

Descrizione

tech debt
Description of Technical Debt

The rule is one project, one pipeline, one documentation source (living-doc-utilities
docs/contracts/pipeline-rules.md), and the toolkit rejects multiple and mixed documentation inputs. Merging two
sources of one project (GitHub issues and Azure DevOps work items, or two collector runs) would need merge logic here
and a rule change in living-doc-utilities.

Impact of Technical Debt
  • A project documented in two places needs two pipelines and two documents.
Category

Architecture / Design

Priority

Low - Nice to have

Proposed Solution

When a project needs two sources: the rule change first (identity across sources, precedence, provenance), then merge logic in normalize-docs and coverage-matrix.

Effort Estimate

1-2 weeks

Dependencies / Related

The GitHub Issues and Azure DevOps epics.

Additional Context

Measured 2026-11-12 at living-doc-toolkit fea9aa6 (v0.1.0).

Lingua principale
Python
Stelle
0
Fork
0
Merge medio
1g 7h
PR unite (30g)
19

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-toolkit

Tutte le issue di AbsaOSS/living-doc-toolkit

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.