add citation CFF and information about authorship

CITATION.cff

@@ -0,0 +1,35 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+# Note: we use the author alias to record author contributions
+# This is a known limitation of CFF files: https://github.com/citation-file-format/citation-file-format/issues/112
+
+cff-version: 1.2.0
+title: Course Development Guidelines
+message: >-
+  You may cite these materials using the metadata in this
+  file. Please cite our materials if you publish materials
+  derived from these, run a workshop using them, or use
+  the   information in your own work.
+type: dataset
+authors:
+  - given-names: Hugo
+    family-names: Tavares
+    affiliation: Cambridge Centre for Research Informatics Training
+    orcid: 'https://orcid.org/0000-0001-9373-2726'
+    alias: 'writing - original draft; conceptualisation; software'
+  - given-names: Martin
+    family-names: van Rongen
+    affiliation: Cambridge Centre for Research Informatics Training
+    orcid: 'https://orcid.org/0000-0002-1441-367X'
+    alias: 'writing - review & editing; conceptualisation; software'
+  - given-names: Alexia
+    family-names: Cardona
+    affiliation: Cambridge Centre for Research Informatics Training
+    orcid: 'https://orcid.org/0000-0002-7877-5565'
+    alias: 'conceptualisation'
+repository-code: 'https://github.com/cambiotraining/quarto-course-template'
+url: 'https://cambiotraining.github.io/quarto-course-template/'
+license: CC-BY-4.0
+commit: 3c8234e82c7315cfb4d869d9635433bf62baf17f
+date-released: '2024-08-23'

index.md

@@ -41,55 +41,19 @@ Exercises in these materials are labelled according to their level of difficulty
 | {{< fa solid star >}} {{< fa solid star >}} {{< fa solid star >}} | Exercises in level 3 require going beyond the concepts and syntax introduced to solve new problems. |
 
 
-## Authors
-<!-- 
-The listing below shows an example of how you can give more details about yourself.
-These examples include icons with links to GitHub and Orcid. 
--->
-
-About the authors:
-
-- **Alexia Cardona**
-  <a href="https://orcid.org/0000-0002-7877-5565" target="_blank"><i class="fa-brands fa-orcid" style="color:#a6ce39"></i></a> 
-  <a href="https://github.com/ac812" target="_blank"><i class="fa-brands fa-github" style="color:#4078c0"></i></a>  
-  _Affiliation_: Bioinformatics Training Facility, University of Cambridge  
-  _Roles_: conceptualisation
-- **Hugo Tavares**
-  <a href="https://orcid.org/0000-0001-9373-2726" target="_blank"><i class="fa-brands fa-orcid" style="color:#a6ce39"></i></a> 
-  <a href="https://github.com/tavareshugo" target="_blank"><i class="fa-brands fa-github" style="color:#4078c0"></i></a>  
-  _Affiliation_: Bioinformatics Training Facility, University of Cambridge  
-  _Roles_: writing - original draft; conceptualisation; coding
-- **Martin van Rongen**
-  <a href="https://github.com/mvanrongen" target="_blank"><i class="fa-brands fa-github" style="color:#4078c0"></i></a>  
-  _Affiliation_: Bioinformatics Training Facility, University of Cambridge  
-  _Roles_: writing - review & editing; conceptualisation; coding
-
-
-## Citation
-
-<!-- We can do this at the end -->
+## Citation & Authors
 
 Please cite these materials if:
 
 - You adapted or used any of them in your own teaching.
-- These materials were useful for your research work. For example, you can cite us in the methods section of your paper: "We carried our analyses based on the recommendations in _TODO_.".
-
-You can cite these materials as:
-
-> TODO
+- These materials were useful for your research work. For example, you can cite us in the methods section of your paper: "We carried our analyses based on the recommendations in _YourReferenceHere_".
 
-Or in BibTeX format:
+<!-- 
+This is generated automatically from the CITATION.cff file. 
+If you think you should be added as an author, please get in touch with us.
+-->
 
-```
-@Misc{,
-  author = {},
-  title = {},
-  month = {},
-  year = {},
-  url = {},
-  doi = {}
-}
-```
+{{< citation CITATION.cff >}}
 
 
 ## Acknowledgements

materials/03-authorship.md

@@ -0,0 +1,28 @@
+---
+title: Authorship
+---
+
+## Being an author
+
+We welcome contributions to our course materials. 
+If your contributions become substantial, you may be added as an author. 
+We currently have no hard rule about what constitues sufficient work for an authorship.
+If you think you should be an author on one of our courses, please get in touch. 
+
+We also acknowledge smaller contributions under the Acknowledgements section of the course front page.
+
+
+## Citation
+
+We use the [Citation File Format (CFF)](https://citation-file-format.github.io/) to keep information about authorship in our materials. 
+Although this format is primarily designed for software and data, we adopted it [following The Carpentries](https://carpentries.org/blog/2024/07/lesson-cffs/) training community. 
+
+Each repository has a `CITATION.cff` file, which is used to automatically populate the course front page with citation format and author information. 
+
+
+## Author roles
+
+Unfortunately, at the present the CFF format schema does not allow adding an author "role" ([see here](https://github.com/citation-file-format/citation-file-format/issues/112)). 
+As a workaround, we use the author `alias` entry to record this information. 
+
+We don't have a formal ontology for author roles, although we take inspiration from [CRT](https://credit.niso.org/contributor-roles-defined/) and [DataCite](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/contributorType/). 

materials/_chapters.yml

@@ -3,4 +3,5 @@ book:
     - part: "Developer Guidelines"
       chapters:
         - materials/01-render_guidelines.md
-        - materials/02-content_guidelines.md
+        - materials/02-content_guidelines.md
+        - materials/03-authorship.md