This PR adds a new service to the publishing metadata service that automatically creates a README file for a submission constructed out of its NERDm metadata. Users can download the file, edit it, and then submit it to MIDAS as a normal distribution file.
The auto-generation is accessed via the URL, /midas/id/README.txt?auto=1. This will return the generated README text file; by default, this text will include prompts to the use to aid in editing file. An additional parameter to the URL, flags, modifies the output. If the value includes a P, editing prompts will be excluded. If B (mnuemonic: "brief") is included, the README will not list the files in the collection (helpful when the collection is large).
This was tested by a user testing group via midastraining and dataputest; see the GitLab feedback repo for feedback.
This PR adds a new service to the publishing metadata service that automatically creates a README file for a submission constructed out of its NERDm metadata. Users can download the file, edit it, and then submit it to MIDAS as a normal distribution file.
The auto-generation is accessed via the URL,
/midas/id/README.txt?auto=1. This will return the generated README text file; by default, this text will include prompts to the use to aid in editing file. An additional parameter to the URL,flags, modifies the output. If the value includes aP, editing prompts will be excluded. IfB(mnuemonic: "brief") is included, the README will not list the files in the collection (helpful when the collection is large).This was tested by a user testing group via midastraining and dataputest; see the GitLab feedback repo for feedback.