search

Garden-AI / garden

https://garden-ai.readthedocs.io
MIT License
16 stars 4 forks source link

Let users opt in to when their DOIs are registered #405

Closed WillEngler closed 5 months ago

WillEngler commented 5 months ago

Closes #400

Overview

This PR adds new commands garden-ai garden register-doi and garden-ai entrypoint register-doi. These will promote the draft DOIs that Garden mints for all gardens and entrypoints to "registered" and "findable" status in Datacite.

This change is prompted by early feedback that Garden proactively creating and registering DOIs was surprising. This change makes it so that users have the option to review their work before pulling the trigger and making the DOI for an entrypoint or garden official.

The PR also adds to the list commands to let users easily see the draft statuses of their DOI.

Screenshots

Screenshot 2024-02-08 at 4 18 48 PM Screenshot 2024-02-08 at 4 41 55 PM

Discussion

As I was reviewing how we deal with DOIs, it became clear that our support for users bringing their own DOI (not one generated with our account) is broken. This PR does not attempt to fix that. It also doesn't attempt to manage draft status of externally generated DOIs.

Testing

I tested this manually and added tests for the new commands. I intend to do more end to end testing against the prod DataCite account with this ticket.

Documentation

Just inline CLI help for now.

📚 Documentation preview 📚: https://garden-ai--405.org.readthedocs.build/en/405/

WillEngler commented 5 months ago

Yeah, I don't know exactly where and how to put it in the docs yet, but yes we should.