docs: ADR infrastructure, story authoring workflow, and InvenioRDM stakeholder documents#1480
Conversation
️✅ There are no secrets present in this pull request anymore.If these secrets were true positive and are still valid, we highly recommend you to revoke them. 🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request. |
43e8a75 to
a505323
Compare
Add a pure UI prototype for the 'Connect datasets with research projects' feature (Stories 01-08), demonstrating search, connect, view, sync, and remove interactions for open and restricted datasets on InvenioRDM instances (Zenodo, FDAT). Files added: - datamanager-app/.../demo/AssociatedDatasetsDemo.java: Development-profile-only Vaadin view at /test-view/associated-datasets with a Public/Restricted tab layout, mock data, and inline actions. - docs/feature-vision-associated-datasets.md: Reformatted feature vision document with background, scope, and user stories. - ui-screenshot(-restricted).png: Visual reference of the prototype for PR review. The demo uses existing project UI patterns (Section, ActionBar, InfoBox, Tag, TabSheet) and requires no real backend integration.
…rototype - ADR infrastructure: introduce docs/adr/ with MADR template (from https://adr.github.io/madr/), README with rules and index, and LICENSE. Provides a lightweight, append-only log for recording significant architectural decisions. - Governance: update AGENTS.md §11.1 (Story Lifecycle) to define the two decoupled surfaces (stakeholder space / developer space) and the PO as handoff actor. Wire ADR references into docs/requirements.md and docs/requirements-guide.md. - Stakeholder documents: add feature brief and resource information spec for the InvenioRDM dataset connection feature. - Prototype: extend AssociatedDatasetsDemoV2 with account settings workflow for InvenioRDM credential management.
…d integration The InvenioRDM FAIR Signposting serialization bug is upstream and will not be ready in time for a Data Manager feature delivery. The current integration uses the InvenioRDM OpenAPI directly. Correction notes were added to the markdown renderings of the stakeholder brief to preserve the original wording while clearly flagging the change.
The file was modified on the prototype branch with ~868 lines removed. Those styles are used by production dialogs across the application and must not be removed. Revert to the origin/development version of the file. Prototype-specific CSS additions, if needed, belong in a prototype-only stylesheet — not in the production dialog.css component stylesheet.
abaf233 to
fd8aeb4
Compare
|


WIP: InvenioRDM Dataset Connection — Documentation, Governance, and Prototype
What's in this PR
📘 Governance & Documentation
docs/adr/directory with:docs/adr/templates/madr-template.md) — blank template for creating Architecture Decision RecordsREADME.md— index, naming convention, creation rules, and lifecycle (append-only)templates/LICENSE.md— MADR license attribution (MIT OR CC0-1.0)AGENTS.md§11.1 updated to define the two decoupled surfaces (stakeholder space = Word Online/SharePoint, PO-internal; developer space = GitHub/docs/features.md) and cast the PO as the handoff actor. Post-approval changes now explicitly go through GitHub PRs.docs/requirements.mdanddocs/requirements-guide.mdnow link ADR mentions todocs/adr/README.md.📄 Stakeholder Documents (reference only)
AGENTS.md §11.1.🎨 Prototype UI (AssociatedDatasetsDemoV2)
📝 Related documentation
docs/feature-vision-associated-datasets.md— vision document (with a note flagging the updated integration mechanism)docs/prototypes/connect-resources/— init prompts for prototype exploration sessionsGitHub Issues (already created)
FEAT-DATASET-CONNECTIONProposed Requirement IDs (pending formal addition to
docs/requirements.md)DATA-R-01DATA-R-02DATA-R-03COMM-R-01Integration Mechanism
The original feature brief was designed around FAIR Signposting as the integration mechanism. This has been revised — a severe bug in InvenioRDM's FAIR Signposting serialization has been reported upstream, and the fix is scheduled for a future major release that would delay the feature unacceptably. The current design uses conventional API-based integration against the InvenioRDM OpenAPI. The markdown renderings of the feature brief in the repo (
docs/feature-vision-associated-datasets.mdanddocs/prototypes/connect-resources/2026-06-19_FEATURE_Connect_associated_datasets.md) still carry the original stakeholder wording but include a prominent correction note.AGENTS.md§11.1) currently describes a PO-as-bridge model but the PO did not author the GitHub issues directly (the issues were created as part of this PR's exploration). Need to reconcile with the workflow: PO reviews the issues and provides explicit approval before they become the authoritative source of truth.docs/requirements.md.img.png,img_1.png,ui-screenshot-restricted.png) anddev.bundleare prototype artifacts — may warrant cleanup before final merge.Testing notes
Prototype-only at this stage. No production tests apply to the documentation changes. The prototype Java view is annotated with
@AnonymousAllowedfor local exploration.