search

omeka-s-modules / PersistentIdentifiers

Create/import/assign persistent identifiers to Omeka S items
GNU General Public License v3.0
0 stars 0 forks source link

Documentation: Persistent Identifiers Module #5

Closed matthewjmckinley closed 2 years ago

matthewjmckinley commented 2 years ago

This module is ready for documentation. Features and operation are pretty well covered in the testing issue, but please let me know if I can clarify or elaborate anywhere!

katknow commented 2 years ago

I will give this another proofread (especially to make sure it matches style guidelines), but here's the first draft if you'd like to take a look and suggest changes. Like you said, the testing feature covered it pretty well.

matthewjmckinley commented 2 years ago

This looks great from a technical standpoint. I have a few small suggestions for wording etc., but those can wait until after you take another pass. Overall it is spot on!

katknow commented 2 years ago

Here's an updated draft for the PID Module to better reflect style guidelines and simplify language. I'm happy to make any wording changes.

matthewjmckinley commented 2 years ago

"Note that this password does not save" might be unclear -- the password does save, it just can't be accessed and re-shown within the form field (Laminas form default, for added security). I would maybe change to "Note that for security reasons this password doesn't persist in the form, so if changes...".

Also for DataCite Required Metadata, the Resource Type General property must conform to a ResourceTypeGeneral controlled value exactly, i.e. "Text" is correct but "text" is not. This tripped me up for a while testing. It's mentioned in the drop-down within the form but maybe also mention it here and link to the controlled vocab value list.

Otherwise looks good to go, thanks!