NHSDigital / DataDictionaryPublication

Apache License 2.0
7 stars 1 forks source link

Change Request Paper repository - for post-migration papers #596

Open stevebowring opened 2 weeks ago

stevebowring commented 2 weeks ago

User needs As an NHS Data Model and Dictionary User I want to be able to access Change Request Papers So that I can understand how a Data Set has changed or is constructed.

Current capability Users are able to access Change Papers via as part of the Release History webpage, organised by date. But are not yet able to access Papers via each individual Data Item's Change Log.

Expected capability On clicking a link in a Data Item's Change Log the relevant Change Request Papers are presented as an in-browser pdf.

Development proposal Dummy Links have been developed to appear in a Data Item's Change Log - the links are configurable to direct users to a specific file in a specific location. Data Solutions to create a Repository for post-migration Mauro/DDPM generated Change Request Papers. Data Solutions to enable automatic storage into the Repository when Papers are generated by the DDPM.

stevebowring commented 5 days ago

Post migration repository - Data Solutions suggest we use a AWS s3 bucket to house our post migration change papers.

1- AWS S3 bucket :- We can use AWS S3 bucket for integrating it with THE DDPM and using it as a central repository for storing documents. AWS is widely used across the organization and has got security checks in place for authorized access. S3 bucket is basically a machine which can be used for storing documents. We can configure the storage space as per our need.

2- GITHUB Repository:- We can use GitHub repository for storing documents. GitHub is also widely used across the organization and has got security checks for authorized access.

For 1 - Data Solutions would create an s3 and link it to the DDPM to send CR Papers to the repository once they are generated- the repository needs to be referenced by the website (via conjuration capability in Mauro).

stevebowring commented 2 days ago

Only final versions of Change Papers to be saved (Published versions) - DDPM requires development to identify and store final version.

Uploading via DDPM is preferred method