Skip to content

Commit bb40a17

Browse files
author
protohedgehog
committed
Appended image formats to render properly (in theory..)
1 parent 3ecce1d commit bb40a17

File tree

3 files changed

+23
-23
lines changed

3 files changed

+23
-23
lines changed

content_development/MAIN.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
"* Contributor; and\n",
134134
"* Committer.\n",
135135
"\n",
136-
"A *maintainer* is a user with 'commit' access to implement suggested changes to the project. They have responsibility for the direction and improvement of the project. A *contributor* is someone who directly adds value to the project through issue resolution, code writing, or even external activities such as communications and event organisation. A *committer* is someone who can make 'commits' to the project (see [Task 1](Task_1.md)).\n",
136+
"A *maintainer* is a user with 'commit' access to implement suggested changes to the project. They have responsibility for the direction and improvement of the project. A *contributor* is someone who directly adds value to the project through issue resolution, code writing, or even external activities such as communications and event organisation. A *committer* is someone who can make 'commits' to the project (see [Task 1](Task_1.ipynb)).\n",
137137
"\n",
138138
"Typically, roles are made public through either the README file, a Contributors file, or a separate team page for the project.\n",
139139
"\n",
@@ -159,7 +159,7 @@
159159
"\n",
160160
"Other similar project hosting services include [BitBucket](https://bitbucket.org/), [GitLab](https://about.gitlab.com/), and [Launchpad](https://launchpad.net/).\n",
161161
"\n",
162-
"**[GO TO TASK 1: Building your first GitHub repository](Task_1.md)**\n",
162+
"**[GO TO TASK 1: Building your first GitHub repository](Task_1.ipynb)**\n",
163163
"\n",
164164
"<br/>\n",
165165
"\n",
@@ -196,7 +196,7 @@
196196
"\n",
197197
"<br/>\n",
198198
"\n",
199-
"If you follow these steps, along with the processes in [**Task 1**](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_1.md) and [**Task 2**](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_2.md), you should be fine!\n",
199+
"If you follow these steps, along with the processes in [**Task 1**](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_1.ipynb) and [**Task 2**](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_2.ipynb), you should be fine!\n",
200200
"\n",
201201
"<br/>\n",
202202
"\n",
@@ -246,7 +246,7 @@
246246
"\n",
247247
"* **Specificity**: Software citations should facilitate identification of, and access to, the specific version of software that was used. Software identification should be as specific as necessary, such as using version numbers, revision numbers, or variants such as platforms.\n",
248248
"\n",
249-
"Note: For instructions on 'how to make your software citable' see the section [**Using GitHub and Zenodo**](#GitHub_Zenodo) and [**Task 2: Linking GitHub and Zenodo**](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_2.md).\n",
249+
"Note: For instructions on 'how to make your software citable' see the section [**Using GitHub and Zenodo**](#GitHub_Zenodo) and [**Task 2: Linking GitHub and Zenodo**](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/Task_2.ipynb).\n",
250250
"\n",
251251
"<br/>\n",
252252
"\n",
@@ -260,7 +260,7 @@
260260
"\n",
261261
"A lot of researchers might typically be afraid of sharing code which is incomplete, buggy, or imperfect. However, in the OSS community, such a practice of sharing 'raw' code is fairly commonplace. Sharing code openly enables others to re-use and improve it, as well as to engage in a deeper way with any research associated with it. This is one of the fundamental aspects of peer-collaboration, perhaps best exemplified by the traditional process of research manuscript peer review.\n",
262262
"\n",
263-
"**[GO TO TASK 2: Linking GitHub and Zenodo](Task_2.md)**\n",
263+
"**[GO TO TASK 2: Linking GitHub and Zenodo](Task_2.ipynb)**\n",
264264
"\n",
265265
"<br/>\n",
266266
"\n",

content_development/Task_1.ipynb

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"* [Check-list for launching your project](#Check-list)\n",
2727
"\n",
2828
"<p align=\"center\">\n",
29-
" <img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/Task1.png\" alt=\"Task 1 workflow\" width=\"600\" height=\"861\" style=\"margin-right: 30px; margin-left: 10px;\" onmouseover=\"this.width='1200'; this.height='1722'\" onmouseout=\"this.width='600'; this.height='861'\">\n",
29+
" <img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/Task1.png?raw=true\" alt=\"Task 1 workflow\" width=\"600\" height=\"861\" style=\"margin-right: 30px; margin-left: 10px;\" onmouseover=\"this.width='1200'; this.height='1722'\" onmouseout=\"this.width='600'; this.height='861'\">\n",
3030
"</p>\n",
3131
"\n",
3232
"<p align=\"center\"><i>The workflow for Task 1. Keep this handy as you work through the task!</i></p>\n",
@@ -40,7 +40,7 @@
4040
"One of the most important things to consider at this early stage is to think about how you want the wider community to interact with your project. As you are working in the open, you want to make sure others feel comfortable in accessing, viewing, and engaging with your work. Setting up a repository in a way that lowers the barriers to entry, and the fear of being an 'outsider' is the first step towards maintaining a successful project.\n",
4141
"\n",
4242
"<p align=\"center\">\n",
43-
" <img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/octocat.png\" width=\"150px\" height=\"125px\"/>\n",
43+
" <img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/octocat.png?raw=true\" width=\"150px\" height=\"125px\"/>\n",
4444
"</p>\n",
4545
"\n",
4646
"<p align=\"center\"><i>Octocat, GitHub's little mascot</i></p>\n",
@@ -51,7 +51,7 @@
5151
"\n",
5252
"To set up a GitHub profile, simply head to the main page and click [Sign Up for GitHub](https://github.com/join). Here, you can create your personal account, with a username, email, and password as standard.\n",
5353
"\n",
54-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/github_signup.png\" width=\"800\" /></p>\n",
54+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/github_signup.png?raw=true\" width=\"800\" /></p>\n",
5555
"\n",
5656
"<p align=\"center\"><i>Sign up for GitHub</i></p>\n",
5757
"\n",
@@ -98,7 +98,7 @@
9898
"\n",
9999
"On your GitHub profile, click the 'Create new repository'. The first step is to create a name as the brand for your project. Ideally, it should be memorable and give some indication of what the project does.\n",
100100
"\n",
101-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/new_repo.png\" width=\"800\" /></p>\n",
101+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/new_repo.png?raw=true\" width=\"800\" /></p>\n",
102102
"\n",
103103
"<p align=\"center\"><i>Create a new repository</i></p>\n",
104104
"\n",
@@ -128,7 +128,7 @@
128128
"3. CONTRIBUTING.md\n",
129129
"4. CODE_OF_CONDUCT.md\n",
130130
"\n",
131-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/foundation.png\" width=\"800\" /></p>\n",
131+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/foundation.png?raw=true\" width=\"800\" /></p>\n",
132132
"\n",
133133
"<p align=\"center\"><i>The basic repository structure</i></p>\n",
134134
"\n",
@@ -148,7 +148,7 @@
148148
"\n",
149149
"Thankfully, when you start a new repository on GitHub, you are given the option to select an existing license from a drop-down menu. You should always (with very few exceptions) use an existing license, since this is what potential users and contributors will see before they choose to use or contribute to your software.\n",
150150
"\n",
151-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/license.png\" width=\"800\" /></p>\n",
151+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/license.png?raw=true\" width=\"800\" /></p>\n",
152152
"\n",
153153
"<p align=\"center\"><i>Choosing an example license</i></p>\n",
154154
"\n",
@@ -162,7 +162,7 @@
162162
"\n",
163163
"When you initialise your new repository, there should be an option to do so with a README file. Just like Alice in Wonderland, these do exactly what they say - provide key information about the project. These are typically the first thing outside contributors will see when they come to your repository, so making them informative and welcoming is key.\n",
164164
"\n",
165-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/readme.png\" width=\"800\" /></p>\n",
165+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/readme.png?raw=true\" width=\"800\" /></p>\n",
166166
"\n",
167167
"<p align=\"center\"><i>Part of the README file for this module</i></p>\n",
168168
"\n",
@@ -193,7 +193,7 @@
193193
"\n",
194194
"Contributing guidelines are designed to communicate to potential contributors a short guide on how to engage with your project and community. You want to make sure to be welcoming, and indicate that you are eager for participants to engage with your project. Whenever a participant opens a new pull request or creates a new issue, they will see a link to your contribution file.\n",
195195
"\n",
196-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/contributing.png\" width=\"800\" /></p>\n",
196+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/contributing.png?raw=true\" width=\"800\" /></p>\n",
197197
"\n",
198198
"<p align=\"center\"><i>Part of the CONTRIBUTING guidelines for this module</i></p>\n",
199199
"\n",
@@ -227,7 +227,7 @@
227227
"\n",
228228
"To add a code of conduct, you can create your own from scratch by adding a new markdown file, or use existing templates such as the [Contributor Covenant](https://contributor-covenant.org/). Name your file CODE_OF_CONDUCT.md, and make sure it is visible in the README file.\n",
229229
"\n",
230-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/code_of_conduct.png\" width=\"800\" /></p>\n",
230+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/code_of_conduct.png?raw=true\" width=\"800\" /></p>\n",
231231
"\n",
232232
"<p align=\"center\"><i>Part of the CODE OF CONDUCT file for this module, based on the Contributor Covenant</i></p>\n",
233233
"\n",
@@ -259,7 +259,7 @@
259259
"* Assignees indicate who is responsible for working on an issue;\n",
260260
"* Comments for providing feedback.\n",
261261
"\n",
262-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/issues.png\" width=\"800\" /></p>\n",
262+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/issues.png?raw=true\" width=\"800\" /></p>\n",
263263
"\n",
264264
"<p align=\"center\"><i>The issue tracker for the Open Scholarship Strategy project</i></p>\n",
265265
"\n",

content_development/Task_2.ipynb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"- [Additional resources](#Resources)\n",
2424
"\n",
2525
"<p align=\"center\">\n",
26-
" <img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/Task2.png\" alt=\"Task 2 workflow\" width=\"600\" height=\"861\" style=\"margin-right: 30px; margin-left: 10px;\" onmouseover=\"this.width='1200'; this.height='1722'\" onmouseout=\"this.width='600'; this.height='861'\">\n",
26+
" <img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/Task2.png?raw=true\" alt=\"Task 2 workflow\" width=\"600\" height=\"861\" style=\"margin-right: 30px; margin-left: 10px;\" onmouseover=\"this.width='1200'; this.height='1722'\" onmouseout=\"this.width='600'; this.height='861'\">\n",
2727
"</p>\n",
2828
"\n",
2929
"<p align=\"center\"><i>The workflow for Task 2. Keep this handy as you work through the task!</i></p>\n",
@@ -46,7 +46,7 @@
4646
"\n",
4747
"Now head over to [zenodo.org](https://zenodo.org). [Zenodo](https://zenodo.org/) is a platform where you can permanently archive your code and other project elements. Zenodo does this by assigning projects a Digital Object Identifier (DOI), which also helps to make the work more citable. This is different to GitHub, which acts as a place where the actual work on a project takes place, rather than long-term archiving of it. At GitHub, content can be modified, deleted, rewritten, and irreversibly changed, which makes it a bit concerning to be used for longer lasting referencing purposes. Zenodo offers more security and permanence for research outputs.\n",
4848
"\n",
49-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/zenodo.png\" width=\"800\" /></p>\n",
49+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/zenodo.png?raw=true\" width=\"800\" /></p>\n",
5050
"\n",
5151
"<p align=\"center\"><i>Sign up for Zenodo</i></p>\n",
5252
"\n",
@@ -60,7 +60,7 @@
6060
"\n",
6161
"On the Zenodo website authorise it to connect to your GitHub account in the '[Using GitHub](https://zenodo.org/account/settings/github/)' section. Here, Zenodo will redirect you to GitHub to ask for permissions to use '[webhooks](https://developer.github.com/webhooks/)' on your repositories. You want to authorise Zenodo here with the permissions it needs to form those links.\n",
6262
"\n",
63-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/zenodo_github.png\" width=\"800\" /></p>\n",
63+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/zenodo_github.png?raw=true\" width=\"800\" /></p>\n",
6464
"\n",
6565
"<p align=\"center\"><i>Authorize Zenodo to connect with GitHub</i></p>\n",
6666
"\n",
@@ -74,7 +74,7 @@
7474
"\n",
7575
"If you have got this far, this means that Zenodo is now authorised to configure the repository webhooks that it needs to archive the repository and issue it a DOI. To do this, on the Zenodo website navigate to the [GitHub repository listing page](https://zenodo.org/account/settings/github/) and simply click the 'on' button next to your repository.\n",
7676
"\n",
77-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/enabled_repos.png\" width=\"800\" /></p>\n",
77+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/enabled_repos.png?raw=true\" width=\"800\" /></p>\n",
7878
"\n",
7979
"<p align=\"center\"><i>Enable individual GitHub repositories to be preserved in Zenodo</i></p>\n",
8080
"\n",
@@ -84,7 +84,7 @@
8484
"\n",
8585
"Now you have set up a new webhook between Zenodo and your repository. In GitHub, click on the settings for your repository, and the Webhooks tab on the left hand side menu. This should display the new Zenodo webhook configured to Zenodo. Note, it may take a little time for the webhook listing to show up.\n",
8686
"\n",
87-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/webhooks.png\" width=\"800\" /></p>\n",
87+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/webhooks.png?raw=true\" width=\"800\" /></p>\n",
8888
"\n",
8989
"<p align=\"center\"><i>Check that webhooks are enabled for your GitHub repository. Example here using the Open Scholarship Strategy</i></p>\n",
9090
"\n",
@@ -94,15 +94,15 @@
9494
"\n",
9595
"The first time you archive a repository is known as the 'first release'. Each time you create a new version of that repository and archive it, you create a new release. This can be tracked in the 'releases' tab for your repository on GitHub (top center).\n",
9696
"\n",
97-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/first_release.png\" width=\"800\" /></p>\n",
97+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/first_release.png?raw=true\" width=\"800\" /></p>\n",
9898
"\n",
9999
"<p align=\"center\"><i>Check that the repository first release was successful. Example here using the Open Scholarship Strategy</i></p>\n",
100100
"\n",
101101
"<br/>\n",
102102
"\n",
103103
"For the first archived version of your repository, click 'Create a new release' back in Zenodo. Fill in the form and give some details as to what the release entails. For the first release, make sure to call it v1.0.0, as is standard practice.\n",
104104
"\n",
105-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/create_release.png\" width=\"800\" /></p>\n",
105+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/create_release.png?raw=true\" width=\"800\" /></p>\n",
106106
"\n",
107107
"<p align=\"center\"><i>Create a new release. Example here using the Open Scholarship Strategy, for which a first release already exists</i></p>\n",
108108
"\n",
@@ -112,7 +112,7 @@
112112
"\n",
113113
"To view your release on Zenodo you need to visit the [Upload](https://zenodo.org/deposit) tab. To finish the archiving a few more details are needed on Zenodo.\n",
114114
"\n",
115-
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/upload_release.png\" width=\"800\" /></p>\n",
115+
"<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/upload_release.png?raw=true\" width=\"800\" /></p>\n",
116116
"\n",
117117
"<p align=\"center\"><i>Check the new release has been uploaded. Example here shown using the Open Scholarship Strategy</i></p>\n",
118118
"\n",

0 commit comments

Comments
 (0)