omeka-s-modules / DataRepositoryConnector

GNU General Public License v3.0
1 stars 0 forks source link

Documentation: Data Repository Connector Module #2

Closed matthewjmckinley closed 2 years ago

matthewjmckinley commented 2 years ago

This module is also ready for documentation. The testing issue will be of help, also the DSpace and Fedora Connectors share similar workflows so maybe look there. Happy to answer questions, thanks!

katknow commented 2 years ago

Here's the first draft. Like the other, I'm going to do another proofread in relation to style guide etc. I based it heavily on DSpace and Fedora Connectors like you suggested, which was very helpful. How do you feel about the repetition in the lists for each of the different platforms. I was thinking it was helpful as people might be looking specifically at one, but I don't know if that just bogs down the whole page too much. Do you have thoughts about it? Thanks!

matthewjmckinley commented 2 years ago

I think to streamline, you could probably have a "Shared Options" heading or similar for Limit, Files, Comment, Sets/Sites, since they are the same for all services, then have a "Dataverse Options", "Zenodo Options" etc. where you list the more specific URL and metadata format options.

I'd also suggest bolding the option names both at the beginning of the bullet list entry and where they are mentioned again, i.e.

I just think it looks a little clearer.

Finally I don't know if you need a screenshot for each data service entry screen, maybe cut that down to one example. But it's up to you.

Otherwise, looks great!

katknow commented 2 years ago

Those are great suggestions, thanks! Here's the updated version. If this works for you, I'll move it over to the proper repo.

matthewjmckinley commented 2 years ago

Looks good to me!