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

Citation #298

Open
swzCuroverse opened this issue Oct 15, 2022 · 3 comments
Open

Citation #298

swzCuroverse opened this issue Oct 15, 2022 · 3 comments

Comments

@swzCuroverse
Copy link
Contributor

swzCuroverse commented Oct 15, 2022

Should be have a citation written out instead of pointing to the doi? Similar to how we have for the CWL standards and ACM paper?

@kinow
Copy link
Member

kinow commented Oct 15, 2022

Hmm, good question. For a document I am writing I need to cite some pages like the Autosubmit user guide. For that I use a citation more or less like "autosubmit 3.14.0 documentation - Section ABC - Accessed 10/Oct/2022". I guess someone could want to cite the user guide directly and we could provide a bibtex or some snippet for users to copy in the footer or somewhere else? (Would be nice if sphinx had a way to auto-generate the citation for readers of each page/section).

@tom-tan
Copy link
Member

tom-tan commented Oct 17, 2022

How about storing CITATION file in Github repo rather than maintaining human-readable citations by hand?

We can see an example in citation-file-format/ruby-cff. We can get the citation string via Cite this repository.

@mr-c
Copy link
Member

mr-c commented Oct 17, 2022

For reference, the CITATION.cff from the main CWL repo: https://github.com/common-workflow-language/common-workflow-language/blob/main/CITATION.cff ; for the User Guide we can add the "all versions" Zenodo DOI as the main entry and move the CACM paper under references

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

No branches or pull requests

4 participants