How to cite this course/repo?

[psteinb]

In order to pay tribute to this fantastic content, I'd love to cite this repo or this course. It would be wonderful, if you could share in the README.md how to cite this.
Thanks in advance!

[lesteve]

Thanks for your kind words, it would be nice to add "how to cite this course" to the README indeed.

Having said that, I don't really know how other course repos manage this kind of thing. Suggestions more than welcome!

I am aware of this https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content but not sure we want to have a DOI for particular releases.

[psteinb]

I would encourage you to have DOIs ... for every release if possible.

[lesteve]

A few links I bumped into that may serve as data points:

• https://the-turing-way.netlify.app/welcome#citing-the-turing-way
• https://the-environmental-ds-book.netlify.app/preamble/attribution.html

For now we don't really do releases since the content is regularly evolving but we could if we think this is worth it (e.g. for each MOOC session) ...

[lesteve]

I followed the instructions in https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content. My understanding is that we need to create a github release for Zenodo to create automatically a DOI.

Remaining steps:

• do a github relase for the MOOC 3rd version, see instructions there
• add a small "how to cite us" section in jupyter-book/index.md similarly as in https://inria.github.io/scikit-learn-mooc/ with a link to the DOI. There is a way to use have a DOI link always pointing to the latest version.
• maybe add the DOI badge to the README.md

[lesteve]

I have created a github release with a tag named session-3 and opened #668 to add the DOI info, feed-back on the PR welcome!

[psteinb]

Great news! Thanks for making the effort. This will make it easier for us to cite this material.