Skip to content

docs: ADR infrastructure, story authoring workflow, and InvenioRDM stakeholder documents#1480

Merged
sven1103 merged 9 commits into
developmentfrom
docs/adr-infrastructure-and-dataset-connection-stakeholder-docs
Jul 10, 2026
Merged

docs: ADR infrastructure, story authoring workflow, and InvenioRDM stakeholder documents#1480
sven1103 merged 9 commits into
developmentfrom
docs/adr-infrastructure-and-dataset-connection-stakeholder-docs

Conversation

@sven1103-agent

@sven1103-agent sven1103-agent commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

WIP: InvenioRDM Dataset Connection — Documentation, Governance, and Prototype

Draft PR. This branch carries a prototype-stage exploration of connecting InvenioRDM datasets to Data Manager projects. The documentation, governance updates, and UI prototype included here are works-in-progress, open for early review.

What's in this PR

📘 Governance & Documentation

  • ADR infrastructure — New docs/adr/ directory with:
    • MADR template (docs/adr/templates/madr-template.md) — blank template for creating Architecture Decision Records
    • README.md — index, naming convention, creation rules, and lifecycle (append-only)
    • templates/LICENSE.md — MADR license attribution (MIT OR CC0-1.0)
  • Story authoring workflowAGENTS.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.
  • ADR cross-referencesdocs/requirements.md and docs/requirements-guide.md now link ADR mentions to docs/adr/README.md.

📄 Stakeholder Documents (reference only)

  • Feature brief and Connected Resource Information specification are referenced from GitHub feature issue #1466 and live in stakeholder space (Word Online / SharePoint). They are intentionally not committed to this repository per AGENTS.md §11.1.

🎨 Prototype UI (AssociatedDatasetsDemoV2)

  • Vaadin prototype demonstrating the InvenioRDM dataset search & connect flow
  • Account settings workflow for InvenioRDM credential (token) management
  • Demonstrates open + restricted dataset handling

📝 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 sessions

GitHub Issues (already created)

  • Feature: #1466FEAT-DATASET-CONNECTION
  • Stories: #1467 through #1479 (13 children, linked)
  • Stories 10 and 11 are TBD in the source document and were intentionally not created yet

Proposed Requirement IDs (pending formal addition to docs/requirements.md)

ID Description
DATA-R-01 Dataset Connection Management (search, connect, view, remove)
DATA-R-02 Dataset Synchronisation
DATA-R-03 InvenioRDM Credential Management
COMM-R-01 Project Change Notifications

Integration 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.md and docs/prototypes/connect-resources/2026-06-19_FEATURE_Connect_associated_datasets.md) still carry the original stakeholder wording but include a prominent correction note.

⚠️ Known Open Items

  • Governance update (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.
  • Requirement IDs are proposed and need PO/lead confirmation before being formalized in docs/requirements.md.
  • Prototype Java code is exploratory only — not intended for production merge in this branch.
  • Some binary files (img.png, img_1.png, ui-screenshot-restricted.png) and dev.bundle are 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 @AnonymousAllowed for local exploration.

@sven1103-agent sven1103-agent added the documentation Improvements or additions to documentation label Jul 10, 2026
@gitguardian

gitguardian Bot commented Jul 10, 2026

Copy link
Copy Markdown

️✅ 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.
While these secrets were previously flagged, we no longer have a reference to the
specific commits where they were detected. Once a secret has been leaked into a git
repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.


🦉 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.

@github-actions github-actions Bot added the chore label Jul 10, 2026
@sven1103 sven1103 force-pushed the docs/adr-infrastructure-and-dataset-connection-stakeholder-docs branch from 43e8a75 to a505323 Compare July 10, 2026 09:08
sven1103 added 8 commits July 10, 2026 13:57
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.
@sven1103 sven1103 force-pushed the docs/adr-infrastructure-and-dataset-connection-stakeholder-docs branch from abaf233 to fd8aeb4 Compare July 10, 2026 11:58
@sven1103 sven1103 marked this pull request as ready for review July 10, 2026 11:59
@sven1103 sven1103 requested a review from a team as a code owner July 10, 2026 11:59
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)
D Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

💡 Need a hand with PR review? Try Gitar by Sonar!

@sven1103 sven1103 merged commit 3c1b4cd into development Jul 10, 2026
5 of 6 checks passed
@sven1103 sven1103 deleted the docs/adr-infrastructure-and-dataset-connection-stakeholder-docs branch July 10, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants