search

carpentries-incubator / singularity-introduction

An introduction to singularity
https://carpentries-incubator.github.io/singularity-introduction
Other
12 stars 18 forks source link

Citing this material #4

Open jcohen02 opened 4 years ago

jcohen02 commented 4 years ago

I wasn't sure of the right way to advise people to cite this material while it's still at an alpha development stage. Since the material is relatively complete in terms of the topics it covers and it has already been taught once, it's possible that others will want to teach it so I felt there should be some guidance on citing the material.

I see there's a similar question in the repository for the partner lesson on Docker in issue 24 so I'm assuming there will be some further guidance on this in due course.

For now, I've added something to CITATION but this will need updating. I didn't want to archive this early version on Zenodo quite yet so my intention was to tag the repository 2020.08a matching the version code used in the CITATION file, however, this isn't compatible with the current version tag structure used which I think must be for the version of the template. If this doesn't matter, I'll simply add the 2020.08a tag to the repo in it's current state and that will be fine until we have some further guidance on this.

tobyhodges commented 4 years ago

Thanks for raising this @jcohen02 Coming up with a recommendation for this is on my task list and I'll have an answer for this question and the issue you linked to in the Docker lesson soon.

tobyhodges commented 4 years ago

Hi @jcohen02 I've posted a (kinda long!) response to the issue on the Docker lesson repo, which includes information about recommended structure of the CITATION file and some more information about releases, Zenodo, DOIs, etc. As you're not ready to publish this via Zenodo yet, a lot of that is for future reference only.

I didn't want to archive this early version on Zenodo quite yet so my intention was to tag the repository 2020.08a matching the version code used in the CITATION file, however, this isn't compatible with the current version tag structure used which I think must be for the version of the template.

You guessed right that the existing release tags (up to v9.5.3) are from the lesson template and shouldn't influence your choice of tag/version numbering for the lesson material. I can see the advantages of including date information in the release tag, so your suggestion of 2020.08a is a good one.

In the end I think we will settle on a recommended format for all of this - ideally with associated tooling to automate away a lot of the manual steps involved in making releases, updating the citation info and author list, etc - but we're not there yet and I don't want to hold you back with those details.

Happy to received feedback and (try to) answer questions on this and all other Carpentries Incubator topics.

jcohen02 commented 4 years ago

Thanks @tobyhodges - I've posted a response asking about the use of a tag/version format similar to what I suggested above for pre-release lesson content in the issue in the docker-introduction repo where you detailed some examples of approaches for citing material. For now, I'll tag this repo with 2020.08a as discussed above but happy to follow an alternative approach once you've had a chance to look into this further.

I really like the idea of having some tooling to try and automate some of this but I appreciate that this all takes time and assuming you're happy with my proposed approach for now, I'll stick with that until I hear further.

Thanks again for your help on this. Probably easier to consolidate any further discussion on this in the issue in the docker-introduction repo linked above? I guess this issue can be left open awaiting a final decision on citation content but if you want to close it, please do go ahead.