CAT-FR-AC-02: record the three delivery scope adjustments as ADR 20 - #52
Open
noVaSon wants to merge 1 commit into
Conversation
An external review found that three scope adjustments taken during delivery are traceable only in project-internal records and have no entry in the published architecture decision log. Two of them already carry their technical decision (ADR 9 for the credential-generation withdrawal, ADR 18 for the graph-backend switching mechanism); what was missing in all three cases is the scope dimension - that delivered functionality was consciously reduced, on what grounds, and under what condition it would be restored. ADR 20 records all three in one place and one format, each with the same four statements (reduction, rationale, consequences, reversal): - verifiable-credential-based role assertions: deferred, blocked by the maturity of the identity provider's OpenID4VP/OpenID4VCI support - support for the earlier credential generation: discontinued, cross- referencing ADR 9 rather than restating it - graph-store backend of the shipped default: adjustment in progress, driven by licence compatibility of the redistributed artefacts The entry records decisions only. It asserts no approval or sign-off; the governance record of the approval lives outside this document.
|
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



🚀 Summary
An external review found that three scope adjustments taken during delivery are traceable only in project-internal records and have no entry in the published architecture decision log. Two of the three already carry their technical decision — ADR 9 for the withdrawal of the earlier credential generation, ADR 18 for the graph-backend switching mechanism — but in neither case is the scope dimension recorded: that delivered functionality was consciously reduced, on what grounds, and under what condition it would be restored. The third has no entry at all.
This PR appends ADR 20 to
09_architecture_decisions.adoc, recording all three in one place and one format, each with the same four statements (reduction, rationale, consequences, reversal/reactivation trigger): the deferral of verifiable-credential-based role assertions, the discontinuation of support for the earlier credential generation, and the in-progress substitution of the shipped graph-store default. ADR 20 cross-references ADR 5, ADR 9 and ADR 18 rather than restating their content.This change is part of the Enhancement of XFSC Federated Catalogue. Details can be found here (permalink):
https://github.com/eclipse-xfsc/docs/blob/f3c6e6b6fbcc87732a1dfe83f060fa58a9a97873/federated-catalogue/src/docs/CAT%20Enhancement/CAT_Enhancement_Specifications%20v1.0.pdf
✅ What's Changed
🧪 How to Test
federated-catalogue/src/docs/architecture/chapters/09_architecture_decisions.adocand jump to the end of the file.====sub-sections each answer the same four questions in the same order, so the three adjustments can be compared at a glance.===/====headings appear at the right levels in the table of contents.🔍 Related Issues
Closes #
Related to #
📸 Screenshots (if applicable)
Not a UI change.
📋 Checklist
Reviewer notes
This entry records decisions; it asserts no approval. The review finding asks for a recorded approval of the deferral. An approval is not something this PR can create — ADR 20 states the decision, its reason and its reversal condition. Recording the eco/PMO sign-off itself remains a human action outside this document (the QA workbook).
Two deliberate wording choices, both responses to the review:
One known inaccuracy in ADR 9 that ADR 20 does not inherit and does not fix. ADR 9 states that credentials in the earlier format "cannot be uploaded to the catalogue". In the delivered behaviour such a credential is not rejected — it is no longer recognised as a credential and is stored as unverified generic data, so it must be re-issued to regain verified status. ADR 20's consequences paragraph uses the accurate wording. Correcting ADR 9 itself is out of scope here and should be its own change.