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

Accepted SPEC should have DOI #159

Open
pllim opened this issue Sep 28, 2022 · 8 comments
Open

Accepted SPEC should have DOI #159

pllim opened this issue Sep 28, 2022 · 8 comments
Labels
enhancement New feature or request

Comments

@pllim
Copy link
Contributor

pllim commented Sep 28, 2022

You probably will do it but just in case...

@stefanv
Copy link
Member

stefanv commented Sep 28, 2022

Do DOIs refer to a specific version of a document, or just to a URL in general? If the latter, should be feasible.

@pllim
Copy link
Contributor Author

pllim commented Sep 28, 2022

I think whatever works for you is fine. Though if the SPEC is going to be hard to change after being finalized and each subsequent edit is significant in itself, a separate DOI per version might be better. But otherwise, general is easier to maintain?

@stefanv
Copy link
Member

stefanv commented Sep 28, 2022

Yes, the reason I am asking is because SPECs are defined to be living documents, so the idea is that they will evolve over time. The history will be in github, of course.

What is the advantage of having a DOI, other than a shorter URL?

@pllim
Copy link
Contributor Author

pllim commented Sep 29, 2022

I was thinking more like Zenodo for citation. Is that appropriate here? https://zenodo.org/

@stefanv
Copy link
Member

stefanv commented Sep 29, 2022

@jarrodmillman may be better positioned to answer that question.

@MridulS
Copy link
Member

MridulS commented Sep 29, 2022

Zenodo can indeed give out "living" DOIs, it has a base link which redirects to the latest version of a document/artifact.

@bsipocz
Copy link
Member

bsipocz commented Sep 10, 2024

This maybe interesting to be revisited. The first issue that comes in mind regarding zenodo that it track artifacts (in practice GH releases) in a repo; so I don't trivially see how to set it up for this repo where each and every SPECs should have their own separate "living" DOI as opposed to one that tracks the repo releases.

@bsipocz bsipocz added the enhancement New feature or request label Sep 10, 2024
@pllim
Copy link
Contributor Author

pllim commented Sep 10, 2024

Yeah, over at Astropy APEs, we have to manually upload each edit via shared account, which is painful. But APE isn't supposed to change very often, so... 🤷‍♀️

GitHub hook via "release" would definitely be much convenient but you will need another way to track individual updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants