More than one documentation source in one pipeline run
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- backend, data-engineering
Research direction
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.
Written by the indexing model from the issue text.
Description
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).
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AbsaOSS/living-doc-toolkit
-
tech debt
Difficulty 1/5 Under an hour Newbie friendliness 88/100
AbsaOSS/living-doc-toolkit#120 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 Half a day Newbie friendliness 84/100
AbsaOSS/living-doc-toolkit#118 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
AbsaOSS/living-doc-toolkit#116 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
AbsaOSS/living-doc-toolkit#115 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 4/5 1-2 days Newbie friendliness 55/100
AbsaOSS/living-doc-toolkit#119 ·
Maintainers usually reply within 1 day
All issues in AbsaOSS/living-doc-toolkit
Similar issues
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
JheysonJhordyHuarauyaRiquelme/sprocguard#18 ·
Maintainers usually reply within 1 day
-
enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
dlq/synthpopcan#59 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mdn/translated-content#40220 ·
Maintainers usually reply within 4 days
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
ETSInitiative/PETSIRD#243 ·
Maintainers usually reply within 1 day
-
deferred p2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
cuadrao-ai/argus#2160 ·
Maintainers usually reply within 1 day