markdown source builds

Auto-generated via {sandpaper} Source : ca2c0b3 Branch : main Author : Robert Davey <[email protected]> Time : 2024-04-11 14:59:03 +0000 Message : Merge pull request #192 from carpentries/188-document-cff-support Document CFF support
carpentries · Apr 11, 2024 · 5adbbbb · 5adbbbb
1 parent 94468e5
commit 5adbbbb
Show file tree

Hide file tree

Showing 2 changed files with 102 additions and 1 deletion.
diff --git a/editing.md b/editing.md
@@ -314,6 +314,107 @@ of this page and this will be the first page that anyone sees.
 This page gives information to maintainers about what to expect inside of th
 repository and how to contribute. 
 
+## Making your lesson citable
+You can add information about how people should cite your lesson by adding a citation file to your lesson repository. If the root folder of your lesson project includes a file called `CITATION` or `CITATION.cff`, the _'Cite'_ page footer of your lesson site will link to this file.
+
+We recommend that you add and maintain a `CITATION.cff` file for your lesson, in [Citation File Format](https://citation-file-format.github.io/) (CFF). CFF is a structured text file format that provides machine-readable citation information for projects. It is supported by a growing number of tools, including GitHub: if a project includes a CFF file in its default branch, [GitHub will present citation information for the project](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files) under a _'Cite this repository'_ button in the _About_ sidebar.
+
+### Creating a CFF for a lesson
+
+You can use the [`cffinit` webtool](https://citation-file-format.github.io/cff-initializer-javascript/) to create a new CFF for your lesson or update an existing file.
+When creating a CFF for a lesson, you should specify `dataset` as the type of work being described ([This discussion includes explanation for why `dataset` is the appropriate type for a lesson](https://github.com/carpentries/sandpaper/issues/508#issuecomment-1699302887).)
+
+::::::::::::::::::::::::::::::::::::::::: spoiler
+
+### Example CFF for this lesson
+
+```
+cff-version: 1.2.0
+title: Introduction to The Carpentries Workbench
+message: >-
+  Please cite this lesson using the information in this file
+  when you refer to it in publications, and/or if you
+  re-use, adapt, or expand on the content in your own
+  training material. To cite the Workbench software itself,
+  please refer to the websites for the individual
+  components:
+  https://carpentries.github.io/sandpaper/authors.html#citation,
+  https://carpentries.github.io/pegboard/authors.html#citation,
+  https://carpentries.github.io/varnish/authors.html#citation
+type: dataset
+authors:
+  - given-names: Zhian
+    family-names: Kamvar
+    name-particle: N.
+    orcid: 'https://orcid.org/0000-0003-1458-7108'
+  - given-names: Toby
+    family-names: Hodges
+    email: [email protected]
+    affiliation: The Carpentries
+    orcid: 'https://orcid.org/0000-0003-1766-456X'
+  - given-names: Erin
+    family-names: Becker
+    orcid: 'https://orcid.org/0000-0002-6832-0233'
+  - orcid: 'https://orcid.org/0000-0002-7040-548X'
+    given-names: Sarah
+    family-names: Stevens
+  - given-names: Michael
+    family-names: Culshaw-Maurer
+    orcid: 'https://orcid.org/0000-0003-2205-8679'
+  - given-names: Maneesha
+    family-names: Sane
+  - given-names: Robert
+    family-names: Davey
+    orcid: 'https://orcid.org/0000-0002-5589-7754'
+  - given-names: Amelia
+    family-names: Bertozzi-Villa
+  - given-names: Kaitlin
+    family-names: Newson
+    orcid: 'https://orcid.org/0000-0001-8739-5823'
+  - given-names: Jennifer
+    family-names: Stubbs
+    orcid: 'https://orcid.org/0000-0002-6080-5703'
+  - given-names: Belinda
+    family-names: Weaver
+  - given-names: François
+    family-names: Michonneau
+    orcid: 'https://orcid.org/0000-0002-9092-966X'
+repository-code: 'https://github.com/carpentries/sandpaper-docs'
+url: 'https://carpentries.github.io/sandpaper-docs/'
+abstract: >-
+  Documentation for The Carpentries Workbench, a set of
+  tools that can be used to create accessible lesson
+  websites.
+keywords:
+  - Carpentries
+  - sandpaper
+  - pegboard
+  - varnish
+  - R
+  - pkgdown
+license: CC-BY-4.0
+```
+
+:::::::::::::::::::::::::::::::::::::::::::::::::
+
+### Plain text CITATION file
+
+As an alternative to Citation File Format, you can also use a plain text file, named `CITATION` (i.e. without the `.cff` extension), in which you add guidance for people wanting to cite your lesson in their publications/projects.
+
+::::::::::::::::::::::::::::::::::::::::: spoiler
+
+### Example plain text CITATION file
+
+```
+Please cite this lesson as:
+
+Zhian N. Kamvar et al,
+Introduction to The Carpentries Workbench.
+https://github.com/carpentries/sandpaper-docs
+```
+
+:::::::::::::::::::::::::::::::::::::::::::::::::
+
 
 ::::::::::::::::::::: keypoints
 

diff --git a/md5sum.txt b/md5sum.txt
@@ -6,7 +6,7 @@
 "links.md" "a7ea11385a9d821b8f57edb0951c83ca" "site/built/links.md" "2024-03-12"
 "episodes/introduction.md" "b1ca0d51bfee1538beabc08f46b389cf" "site/built/introduction.md" "2024-03-12"
 "episodes/episodes.Rmd" "4f9401544dcfcd6d0ba5b61dca806f04" "site/built/episodes.md" "2024-04-10"
-"episodes/editing.md" "5f5e2e6187fda127929d1f89bbeee85b" "site/built/editing.md" "2024-03-12"
+"episodes/editing.md" "51d14a223e1a4603e1224d0e624d06dd" "site/built/editing.md" "2024-04-11"
 "episodes/example.Rmd" "215e3c4ed500fef3410f040349fb0a73" "site/built/example.md" "2024-03-12"
 "episodes/deployment.md" "f15377cac190ef5435a60d074aa8aeb3" "site/built/deployment.md" "2024-03-27"
 "episodes/update.md" "e3939117fb9b893806c4f43e7f08594e" "site/built/update.md" "2024-03-12"