Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs? #8

Open
maelle opened this issue Feb 14, 2025 · 6 comments
Open

Docs? #8

maelle opened this issue Feb 14, 2025 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@maelle
Copy link

maelle commented Feb 14, 2025

👋 @mfenner, I wonder where I could find a list of the different commands.

@mfenner
Copy link
Contributor

mfenner commented Feb 15, 2025

The Go documentation of the package is at https://pkg.go.dev/github.com/front-matter/commonmeta, but the documentation of the cli commands and options is still missing. I will work on that. In the meantime the two most important cli commands for your use case are:

commonmeta encode 10.59350
commonmeta decode https://doi.org/10.59350/8vw43-jy784

The first command generates a random DOI string with the prefix your blog uses. The second command validates the DOI string encoded in base32. It returns the random number used for base32 encoding, or an error if the checksum (84 in this case) is wrong.

@mfenner
Copy link
Contributor

mfenner commented Feb 15, 2025

Commonmeta has lots of functionality for working with scholarly metadata, but that is beyond the scope of registering DOIs for a blog post. For example fetch the metadata for any DOI from Crossref and return them in datacite format:

commonmeta convert 10.59350/8vw43-jy784 -t datacite

@mfenner mfenner self-assigned this Feb 16, 2025
@mfenner mfenner added the documentation Improvements or additions to documentation label Feb 16, 2025
@mfenner
Copy link
Contributor

mfenner commented Feb 21, 2025

@maelle it looks like the latest rOpenSci post used the new workflow. Any issues?

@maelle
Copy link
Author

maelle commented Feb 21, 2025

Thank you for the reminder!! Yes it seemed to have worked, https://doi.org/10.59350/5n1pv-3sg04 redirects correctly so it means Rogue Scholar registered it 🙏 🎉 Thanks so much for the support!

@mfenner
Copy link
Contributor

mfenner commented Feb 21, 2025

Great! When you change the guid/id of already registered posts to the DOI, let me know. Otherwise Rogue Scholar has issues with updating posts (it uses the guid/id to uniquely identify a post).

It is recommended to use either the DOI or the permalink for all posts, to keep things simple.

@maelle
Copy link
Author

maelle commented Feb 21, 2025

When you change the guid/id of already registered posts to the DOI

I don't plan to do that, but as you know for older posts we changed it from the URL to the DOI last week or so.

We're now using the DOI for all posts and will keep doing so. Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants