generated from carpentries/workbench-template-md
-
Notifications
You must be signed in to change notification settings - Fork 0
/
fair4rs_config.patch
274 lines (245 loc) · 11.1 KB
/
fair4rs_config.patch
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 0000000..5c69f4d
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,24 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Lesson Title # FIXME
+message: >-
+ If you use this software, please cite it using the
+ metadata from this file.
+type: software
+authors:
+ - given-names: '' # FIXME
+ family-names: '' # FIXME
+ email: '' # FIXME
+ affiliation: University of Sheffield
+ orcid: 'https://orcid.org/0000-XXXX-XXXX-XXXX' # FIXME
+repository-code: 'https://github.com/' # FIXME
+url: '' # FIXME
+abstract: >-
+ # FIXME
+keywords: # FIXME
+ - carpentries
+ - fair4rs
+ - university of sheffield
+license: CC-BY-4.0
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index f19b804..40bd303 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -3,11 +3,11 @@ title: "Contributor Code of Conduct"
---
As contributors and maintainers of this project,
-we pledge to follow the [The Carpentries Code of Conduct][coc].
+we pledge to follow the [University of Sheffield Research Software Engineering Code of Conduct][coc].
Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported by following our [reporting guidelines][coc-reporting].
-[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
-[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html
+[coc-reporting]: https://rse.shef.ac.uk/community/code_of_conduct#enforcement-guidelines
+[coc]: https://rse.shef.ac.uk/community/code_of_conduct
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6c2b81c..f71bc09 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,8 +1,6 @@
## Contributing
-[The Carpentries][cp-site] ([Software Carpentry][swc-site], [Data
-Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source
-projects, and we welcome contributions of all kinds: new lessons, fixes to
+We welcome contributions to this open educational resource: fixes to
existing material, bug reports, and reviews of proposed changes are all
welcome.
@@ -11,15 +9,11 @@ welcome.
By contributing, you agree that we may redistribute your work under [our
license](LICENSE.md). In exchange, we will address your issues and/or assess
your change proposal as promptly as we can, and help you become a member of our
-community. Everyone involved in [The Carpentries][cp-site] agrees to abide by
+community. All contributors agree to abide by
our [code of conduct](CODE_OF_CONDUCT.md).
### How to Contribute
-The easiest way to get started is to file an issue to tell us about a spelling
-mistake, some awkward wording, or a factual error. This is a good way to
-introduce yourself and to meet some of our community members.
-
1. If you do not have a [GitHub][github] account, you can [send us comments by
email][contact]. However, we will be able to respond more quickly if you use
one of the other methods described below.
@@ -31,48 +25,11 @@ introduce yourself and to meet some of our community members.
3. If you are comfortable with Git, and would like to add or change material,
you can submit a pull request (PR). Instructions for doing this are
- [included below](#using-github). For inspiration about changes that need to
- be made, check out the [list of open issues][issues] across the Carpentries.
+ [included below](#using-github).
Note: if you want to build the website locally, please refer to [The Workbench
documentation][template-doc].
-### Where to Contribute
-
-1. If you wish to change this lesson, add issues and pull requests here.
-2. If you wish to change the template used for workshop websites, please refer
- to [The Workbench documentation][template-doc].
-
-
-### What to Contribute
-
-There are many ways to contribute, from writing new exercises and improving
-existing ones to updating or filling in the documentation and submitting [bug
-reports][issues] about things that do not work, are not clear, or are missing.
-If you are looking for ideas, please see [the list of issues for this
-repository][repo-issues], or the issues for [Data Carpentry][dc-issues],
-[Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
-
-Comments on issues and reviews of pull requests are just as welcome: we are
-smarter together than we are on our own. **Reviews from novices and newcomers
-are particularly valuable**: it's easy for people who have been using these
-lessons for a while to forget how impenetrable some of this material can be, so
-fresh eyes are always welcome.
-
-### What *Not* to Contribute
-
-Our lessons already contain more material than we can cover in a typical
-workshop, so we are usually *not* looking for more concepts or tools to add to
-them. As a rule, if you want to introduce a new idea, you must (a) estimate how
-long it will take to teach and (b) explain what you would take out to make room
-for it. The first encourages contributors to be honest about requirements; the
-second, to think hard about priorities.
-
-We are also not looking for exercises or other material that only run on one
-platform. Our workshops typically contain a mixture of Windows, macOS, and
-Linux users; in order to be usable, our lessons must run equally well on all
-three.
-
### Using GitHub
If you choose to contribute via GitHub, you may want to look at [How to
@@ -89,22 +46,10 @@ use [GitHub flow][github-flow] to manage changes:
NB: The published copy of the lesson is usually in the `main` branch.
-Each lesson has a team of maintainers who review issues and pull requests or
-encourage others to do so. The maintainers are community volunteers, and have
-final say over what gets merged into the lesson.
-
-### Other Resources
-
-The Carpentries is a global organisation with volunteers and learners all over
-the world. We share values of inclusivity and a passion for sharing knowledge,
-teaching and learning. There are several ways to connect with The Carpentries
-community listed at <https://carpentries.org/connect/> including via social
-media, slack, newsletters, and email lists. You can also [reach us by
-email][contact].
-[repo]: https://example.com/FIXME
-[repo-issues]: https://example.com/FIXME/issues
-[contact]: mailto:team@carpentries.org
+[repo]: https://github.com/<account>/<repo>#FIXME
+[repo-issues]: https://github.com/<account>/<repo>/issues#FIXME
+[contact]: mailto:rse@sheffield.ac.uk
[cp-site]: https://carpentries.org/
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
[dc-lessons]: https://datacarpentry.org/lessons/
diff --git a/LICENSE.md b/LICENSE.md
index 7632871..a5643a7 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -4,9 +4,23 @@ title: "Licenses"
## Instructional Material
-All Carpentries (Software Carpentry, Data Carpentry, and Library Carpentry)
-instructional material is made available under the [Creative Commons
-Attribution license][cc-by-human]. The following is a human-readable summary of
+This lesson is based on a
+[template](https://github.com/carpentries/workbench-template-md)
+created by [The Carpentries](https://carpentries.org/) which is
+Copyright (c) The Carpentries and is made available under the
+[Creative Commons
+Attribution](https://creativecommons.org/licenses/by/4.0/) licence.
+[Changes have been
+made](https://github.com/RSE-Sheffield/fair4rs-lesson-setup) to adapt the
+template to the specific context of the University of Sheffield's FAIR
+for Research Software training programme.
+
+<!-- #FIXME include reference/attribution for any materials derived
+from other sources -->
+
+Unless otherwise noted, the instructional material in this lesson is
+made available under the [Creative Commons Attribution
+license][cc-by-human]. The following is a human-readable summary of
(and not a substitute for) the [full legal text of the CC BY 4.0
license][cc-by-legal].
@@ -22,12 +36,12 @@ terms.
Under the following terms:
-- **Attribution**---You must give appropriate credit (mentioning that your work
- is derived from work that is Copyright (c) The Carpentries and, where
- practical, linking to <https://carpentries.org/>), provide a [link to the
- license][cc-by-human], and indicate if changes were made. You may do so in
- any reasonable manner, but not in any way that suggests the licensor endorses
- you or your use.
+- **Attribution**---You must give appropriate credit (mentioning that
+ your work is derived from work that is Copyright (c) The University
+ of Sheffield and, where practical, provide a [link to the
+ license][cc-by-human], and indicate if changes were made. You may do
+ so in any reasonable manner, but not in any way that suggests the
+ licensor endorses you or your use.
- **No additional restrictions**---You may not apply legal terms or
technological measures that legally restrict others from doing anything the
@@ -44,9 +58,11 @@ Notices:
## Software
-Except where otherwise noted, the example programs and other software provided
-by The Carpentries are made available under the [OSI][osi]-approved [MIT
-license][mit-license].
+Except where otherwise noted, the example programs and other software
+provided in this work are made available under the [OSI][osi]-approved
+[MIT license][mit-license].
+
+Copyright (c) The University of Sheffield
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
diff --git a/config.yaml b/config.yaml
index b3bfd79..3dd58dd 100644
--- a/config.yaml
+++ b/config.yaml
@@ -17,11 +17,12 @@ title: 'Lesson Title' # FIXME
created: ~ # FIXME
# Comma-separated list of keywords for the lesson
-keywords: 'software, data, lesson, The Carpentries' # FIXME
+keywords: 'software, lesson, The Carpentries, FAIR4RS' # FIXME
# Life cycle stage of the lesson
# possible values: pre-alpha, alpha, beta, stable
-life_cycle: 'pre-alpha' # FIXME
+# (the default, pre-alpha, is the appropriate for brand new lessons)
+life_cycle: 'pre-alpha'
# License of the lesson
license: 'CC-BY 4.0'
@@ -33,7 +34,11 @@ source: 'https://github.com/carpentries/workbench-template-md' # FIXME
branch: 'main'
# Who to contact if there are any issues
-contact: 'team@carpentries.org' # FIXME
+contact: 'rse@sheffield.ac.uk' # FIXME
+
+# Custom URL if you are deploying to a URL that is not the default
+# github pages domain
+# url:
# Navigation ------------------------------------------------
#
@@ -74,5 +79,4 @@ profiles:
#
# This space below is where custom yaml items (e.g. pinning
# sandpaper and varnish versions) should live
-
-
+varnish: RSE-Sheffield/uos-varnish@main
diff --git a/learners/acknowledgements.md b/learners/acknowledgements.md
new file mode 100644
index 0000000..b7cfa23
--- /dev/null
+++ b/learners/acknowledgements.md
@@ -0,0 +1,8 @@
+---
+title: 'Acknowledgements'
+---
+
+This training has been created by the [RSE team](https://rse.shef.ac.uk) at the
+[University of Sheffield](https://www.sheffield.ac.uk/), supported by the
+[Department of Computer Science](https://www.sheffield.ac.uk/dcs) and [IT
+services](https://www.sheffield.ac.uk/it-services/research).