Skip to content

Commit

Permalink
Update skill codes (#36)
Browse files Browse the repository at this point in the history
According to v3of the preprint
https://arxiv.org/abs/2311.11457
  • Loading branch information
MakisH authored Nov 11, 2024
1 parent db2020c commit 527f4be
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Resources are bundled into a [Jekyll collection](https://jekyllrb.com/docs/colle
title: "Research Software Engineering with Python"
link: https://merely-useful.tech/py-rse/index.html
image: https://merely-useful.tech/py-rse/tugboats-800x600.jpg
skills: [DOCBB, LIBS, SWREPOS, SRU, TEAM, PM]
skills: [DOCBB, DIST, SWREPOS, SRU, TEAM, PM]
audience: [learn, teach]
---
An ebook that one can read from front to back, covering the shell and CLI tools, Git basics, Makefiles, Configuration files, as well as a bit of Teamwork, Testing, Error-Handling, and Packaging. The level is mostly basic (also for people that have barely any previous experience with programming), but covers a wide range of essential skills. While Python is in the name, this is not really required.
Expand All @@ -18,5 +18,5 @@ An ebook that one can read from front to back, covering the shell and CLI tools,
- `title:` renders as a heading and URL title of that resource
- `link:` is the main URL
- `image:` is an optional featured image of that resource
- `skills:` is a list of competencies discussed. Valid values are `DOCBB`, `LIBS`, `SWLC`, `SWREPOS`, `MOD`, `NEW`, `RC`, `SRU`, `SP`, `DOMREP`, `TEAM`, `TEACH`, `PM`, `USERS`.
- `skills:` is a list of competencies discussed. Valid values are `SWLC`, `DOCBB`, `DIST`, `SWREPOS`, `MOD`, `NEW`, `RC`, `SRU`, `SP`, `DOMREP`, `TEAM`, `TEACH`, `PM`, `USERS`.
- `audience:` is a list with values from `learn` and `teach`, focusing on the main perspective.
12 changes: 6 additions & 6 deletions _pages/competencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,27 @@ The respective preprint is currently in extensive review from the RSE community.
RSEs are Research **Software Engineers** and, as such, posess software engineering skills
that allow them to create and maintain complex and FAIR (Findable, Accessible, Interoperable, and Reusable) research software.

### Creating documented code building blocks (DOCBB) <a name="DOCBB"></a>
### Adapting to the software life-cycle (SWLC) <a name="SWLC"></a>

{% assign resources = site.resources | where: "skills", "DOCBB" %}
{% assign resources = site.resources | where: "skills", "SWLC" %}
{% for resource in resources %}

- [{{ resource.title }}]({{ resource.link }})

{% endfor %}

### Building distributable libraries (LIBS) <a name="LIBS"></a>
### Creating documented code building blocks (DOCBB) <a name="DOCBB"></a>

{% assign resources = site.resources | where: "skills", "LIBS" %}
{% assign resources = site.resources | where: "skills", "DOCBB" %}
{% for resource in resources %}

- [{{ resource.title }}]({{ resource.link }})

{% endfor %}

### Adapting to the software life-cycle (SWLC) <a name="SWLC"></a>
### Building distributable software (DIST) <a name="DIST"></a>

{% assign resources = site.resources | where: "skills", "SWLC" %}
{% assign resources = site.resources | where: "skills", "DIST" %}
{% for resource in resources %}

- [{{ resource.title }}]({{ resource.link }})
Expand Down
2 changes: 1 addition & 1 deletion collections/_resources/better-scientific-software.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Better Scientific Software"
link: https://bssw.io/
skills: [DOCBB, LIBS, SWLC, SWREPOS, MOD, SRU, SP , TEACH, PM]
skills: [DOCBB, DIST, SWLC, SWREPOS, MOD, SRU, SP , TEACH, PM]
audience: [learn]
---
Material all around writing better scientific software and beyond. See the [list of all BSSw resources](https://bssw.io/items).
2 changes: 1 addition & 1 deletion collections/_resources/effective-computation-in-physics.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Effective Computation in Physics"
link: https://www.oreilly.com/library/view/effective-computation-in/9781491901564/
skills: [DOCBB, LIBS, SWLC, SWREPOS, MOD, SRU, SP, DOMREP]
skills: [DOCBB, DIST, SWLC, SWREPOS, MOD, SRU, SP, DOMREP]
audience: [learn]
---
This O'REILLY book is a great resource that can be very useful for research software beyond Physics. The topics range from terminal, classes and objects, to deploying software, testing, debugging, and copyright.
2 changes: 1 addition & 1 deletion collections/_resources/r-packages.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: R Packages (2e)
link: https://r-pkgs.org/
skills: [SP, LIBS]
skills: [SP, DIST]
audience: [learn]
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Research Software Engineering with Python"
link: https://third-bit.com/py-rse/
image: https://third-bit.com/py-rse/tugboats-800x600.jpg
skills: [DOCBB, LIBS, SWREPOS, SRU, TEAM, PM]
skills: [DOCBB, DIST, SWREPOS, SRU, TEAM, PM]
audience: [learn, teach]
---
An ebook that one can read from front to back, covering the shell and CLI tools, Git basics, Makefiles, Configuration files, as well as a bit of Teamwork, Testing, Error-Handling, and Packaging. The level is mostly basic (also for people that have barely any previous experience with programming), but covers a wide range of essential skills. While Python is in the name, this is not really required.
4 changes: 2 additions & 2 deletions collections/_resources/ropensci-r-package-guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "rOpenSci Package: Development, Maintainence, and Peer Review"
link: https://devguide.ropensci.org/
skills: [SP, LIBS]
skills: [SP, DIST]
audience: [learn]
---
A guide for best practices in developing, maintaining, and reviewing R packages.
A guide for best practices in developing, maintaining, and reviewing R packages.
4 changes: 2 additions & 2 deletions collections/_resources/ropensci.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: rOpenSci
link: https://ropensci.org/
skills: [LIBS, SWREPOS]
skills: [DIST, SWREPOS]
audience: [learn]
---

rOpenSci is an organization that supports development and maintenance of R packages for the sciences. One can submit an R package for review and if accepted it will be migrated to the rOpenSci organization and be searchable through rOpenSci's website. They also have an active Slack community and regular community calls and events.
rOpenSci is an organization that supports development and maintenance of R packages for the sciences. One can submit an R package for review and if accepted it will be migrated to the rOpenSci organization and be searchable through rOpenSci's website. They also have an active Slack community and regular community calls and events.
2 changes: 1 addition & 1 deletion collections/_resources/suresoft.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Suresoft
link: https://suresoft.dev
image: https://suresoft.dev/site/img/branding/Suresoft_Logo.png
skills: [DOCBB, LIBS, SWLC, SWREPOS, MOD, SRU, SP, PM]
skills: [DOCBB, DIST, SWLC, SWREPOS, MOD, SRU, SP, PM]
audience: [learn]
---

Expand Down

0 comments on commit 527f4be

Please sign in to comment.