forked from DMPRoadmap/roadmap
-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
Description
Description
Implement DMP versioning and DOI minting of plans.
Required Steps
Technical Setup
- Repository: Create a new standalone repository for Atlas.
- Dockerization: Containerize the app for consistent builds and deployment.
- Helm Charts: Update/create Helm charts for Kubernetes deployment.
- Tech Stack: It is looking like Atlas may be very frontend. Assuming a lot of DMP Assistant code can't be repurposed, we may go with something like the following:
- Frontend: React for rendering DMP snapshots, routing, and user interactions.
- Backend: Lightweight API proxy for authentication and organizational API requests (Node.js/Express or Rails API).
- Database: Likely not required
API Integration With DMP Assistant
- Expose an API endpoint from DMP Assistant returning all versioned
plan_snapshotsfor a given plan.- Public versions: accessible without authentication.
- Organisational versions: accessible only via an API key.
- Update API key management in DMP Assistant to allow Atlas to authenticate securely
- Currently, DMP Assistant only allows users with at least
org_adminprivileges to access the API. Because any user will be able to publish a new version (or mint a new DOI), we will likely have to allow API authentication for all users. - NOTE: The following are (now-closed) DMPTool issues that may help with the authentication between DMP Assistant and Atlas)
- Currently, DMP Assistant only allows users with at least
User Features
- Subdomain: Atlas will be accessible via a dedicated subdomain (e.g.,
atlas.dmp-pgd.ca) - Public DMPs: Accessible via DOI URLs once minted (
/:doi). - Organizational DMPs: Restricted access based on API key authentication; users with the proper credentials can view metadata and content (also at
/:doi) - Non-DOI versions: Accessible via unique identifiers (
/plans/:plan_id/versions/:version_id). - Tombstone Pages: For DMPs removed from public view, Atlas will display a tombstone page while preserving the DOI.
Reactions are currently unavailable