user_guide icon indicating copy to clipboard operation
user_guide copied to clipboard

Citation

Open swzCuroverse opened this issue 3 years ago • 3 comments

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?

swzCuroverse avatar Oct 15 '22 05:10 swzCuroverse

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).

kinow avatar Oct 15 '22 05:10 kinow

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.

tom-tan avatar Oct 17 '22 01:10 tom-tan

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

mr-c avatar Oct 17 '22 07:10 mr-c