markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5d41b33
Branch  : main
Author  : Aleksandra Nenadic <[email protected]>
Time    : 2024-10-15 16:43:33 +0000
Message : Merge pull request #138 from carpentries-incubator/anenadic-patch-2

Fixes text and extracts links

02-fair-research-software.md

@@ -221,6 +221,7 @@ We recommend the following resources for some additional reading on the topic of
 
 - ["Five recommendations for FAIR software"][5-fair-software-recommendations]
 - ["10 easy things to make your research software FAIR"][10-easy-fair-things]
+- ["Ten simple rules for training scientists to make better software"][10-rules-better-software]
 - [Automating assessment of the FAIR Principles for Research Software (FAIR4RS)][automated-assessment-fairrs]
 - [Short online courses][nesc-rs-support-courses] on various aspects of research software 
 (including [FAIR reseach software][nesc-rs-support-course-fair] and data), by the NeSC Research Software Support

09-code-documentation.md

@@ -295,14 +295,10 @@ code repository (as there is likely not going to be enough time to spend on diff
 :::::: callout
 #### Tools to help you choose a licence
 
-A [short intro](../learners/licensing.md) on different open source software licences included as extra content to this course. 
-
-Check out the [open source guide](https://opensource.guide/legal/#which-open-source-license-is-appropriate-for-my-project) 
-on applying, changing and editing licenses.
-
-The website [choosealicense.com](https://choosealicense.com) has some great
-resources to help you choose a license that is appropriate for your needs, and can even automate adding the LICENSE
-file to your GitHub code repository.
+- A [short intro](../learners/licensing.md) on different open source software licences included as extra content to this course. 
+- [The open source guide][opensource-licence-guide] on applying, changing and editing licenses.
+- [choosealicense.com][choosealicense] online tool has some great resources to help you choose a license that is
+appropriate for your needs, and can even automate adding the LICENSE file to your GitHub code repository.
 
 :::::::
 
@@ -346,11 +342,10 @@ if there is now a license listed.
 
 ### CITATION file
 
-We can add a citation file to our repository to provide instructions on how and when to cite our code.
-A citation file can be a plain text (`CITATION.txt`) or a Markdown file (`CITATION.md`), but there are 
-certain benefits to use a special file format called the Citation File Format (CFF) which provides 
-a way to include richer metadata about software or datasets we want to cite, making it easy
-for both humans and machines to use this information.
+We should add a citation file to our repository to provide instructions on how to cite our code. 
+A citation file can be a plain text (CITATION.txt) or a Markdown file (CITATION.md), but there are certain benefits 
+to using use a special file format called the [Citation File Format (CFF)][cff], which provides a way to include richer 
+metadata about code (or datasets) we want to cite, making it easy for both humans and machines to use this information.
 
 #### Why use CFF?
 
@@ -360,7 +355,7 @@ GitHub also "understands" CFF, and will display citation information prominently
 of a repository that contains citation info in CFF.
 
 For users, having a CFF file makes it easy to cite the software or dataset 
-with formatted citation information available for copy-paste and direct import from GitHub into reference managers like 
+with formatted citation information available for copy+paste and direct import from GitHub into reference managers like 
 Zotero.
 
 #### CFF file format

links.md

@@ -123,4 +123,7 @@ any links that you are not going to use.
 [pypi]: https://pypi.org/
 [cran]: https://cran.r-project.org/web/packages/
 [awesome-rs-registries]: https://github.com/NLeSC/awesome-research-software-registries
-[mkdocs-deploy]: https://www.mkdocs.org/user-guide/deploying-your-docs/
+[mkdocs-deploy]: https://www.mkdocs.org/user-guide/deploying-your-docs/
+[opensource-licence-guide]: https://opensource.guide/legal/#which-open-source-license-is-appropriate-for-my-project
+[choosealicense]: https://choosealicense.com/
+ [10-rules-better software]: https://doi.org/10.1371/journal.pcbi.1012410  

md5sum.txt

@@ -4,16 +4,16 @@
 "LICENSE.md" "b24ebbb41b14ca25cf6b8216dda83e5f" "site/built/LICENSE.md" "2023-10-03"
 "config.yaml" "233c98f6f1660c443ddd943465e06f80" "site/built/config.yaml" "2024-09-26"
 "index.md" "02ad77bddfc822162873c1f532255eeb" "site/built/index.md" "2024-09-13"
-"links.md" "95769884fcb051d978f4508fa523e499" "site/built/links.md" "2024-10-14"
+"links.md" "d1dd35d9cc3d93bb2f68f0dd907ebc53" "site/built/links.md" "2024-10-15"
 "episodes/01-introduction.md" "5ad6ec9b0ec53ca6e861ee719782bca4" "site/built/01-introduction.md" "2024-07-04"
-"episodes/02-fair-research-software.md" "18f32628b3978cc5d6cf4bd05f9a2166" "site/built/02-fair-research-software.md" "2024-10-14"
+"episodes/02-fair-research-software.md" "0f350a97d31c4b23d0383eebca01b06d" "site/built/02-fair-research-software.md" "2024-10-15"
 "episodes/03-tools.md" "90c36d859bdd60723c86d5daef3684c8" "site/built/03-tools.md" "2024-10-14"
 "episodes/04-version-control.md" "fcb7634fb3431936793161a3e63580c8" "site/built/04-version-control.md" "2024-10-14"
 "episodes/05-code-environment.md" "fd7e401e69605b3fbe41322c1d2e8e85" "site/built/05-code-environment.md" "2024-10-14"
 "episodes/06-code-readability.md" "a829d661277e6b2c0ca5e7b09b3255ac" "site/built/06-code-readability.md" "2024-10-14"
 "episodes/07-code-structure.md" "bd697cd5719ac841285f333077ec0c93" "site/built/07-code-structure.md" "2024-10-14"
 "episodes/08-code-correctness.md" "ac5057bb8cdd310a3379038394c621f3" "site/built/08-code-correctness.md" "2024-10-14"
-"episodes/09-code-documentation.md" "94318f688d932a80e3e77267fa065699" "site/built/09-code-documentation.md" "2024-10-14"
+"episodes/09-code-documentation.md" "a8b0dfa872c66c9cda5057ea27b6ee49" "site/built/09-code-documentation.md" "2024-10-15"
 "episodes/10-open-collaboration.md" "a42d52ef478b5127568ca5344a6f39e1" "site/built/10-open-collaboration.md" "2024-10-14"
 "episodes/11-wrap-up.md" "e0334370460adfbb7be9b5d3bf4d319f" "site/built/11-wrap-up.md" "2024-09-17"
 "instructors/instructor-notes.md" "cae72b6712578d74a49fea7513099f8c" "site/built/instructor-notes.md" "2023-10-03"