Skip to content

Commit 45aa982

Browse files
committed
Updating front page, adding contribution include, adding initial content lists to role pages.
1 parent 71aa3c0 commit 45aa982

File tree

10 files changed

+73
-20
lines changed

10 files changed

+73
-20
lines changed

docs/_includes/can-you-help.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
**Can you help contribute content to this page?:** The RSEToolkit is a
2+
community resource that is a work in progress. Can you help to add content
3+
to this page? We'd love to receive your contribution. See our
4+
[contributing guidelines]({{ site.baseurl }}{% link contributing.md %}) for
5+
details of how to provide content. You can also [open an issue](https://github.com/RSEToolkit/RSEToolkit.github.io/issues/new/choose)
6+
highlighting any content you'd like us to provide but aren't able to contribute
7+
yourself.
8+
{: .notice--info}

docs/_pages/index.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ header:
1212
- label: "New to RSE"
1313
url: /roles/new-rse/
1414
- label: "Experienced RSE"
15-
url: "#"
15+
url: "/roles/experienced-rse/"
1616
- label: "Researcher"
17-
url: "#"
17+
url: "/roles/researcher/"
1818
---
1919

20-
# RSE Toolkit: The Research Software Engineer's Toolkit
20+
# RSEToolkit: The Research Software Engineer's Toolkit
2121

22-
The RSE Toolkit (RTK) is intended to be a community developed resource for Research Software Engineers (RSEs), researchers, academics and anyone involved in building research software. If you're a user of research software, or you're new to the field, you may also find a range of useful information on this site and its [associated GitHub repository]({{ site.github.repository_url }}).
22+
The RSEToolkit (RTK) is intended to be a community developed resource for Research Software Engineers (RSEs), researchers, academics and anyone involved in building research software. If you're a user of research software, or you're new to the field, you may also find a range of useful information on this site and its [associated GitHub repository]({{ site.github.repository_url }}).
2323

2424
**Suggest or contribute new content:** The RSEToolkit is a work in progress. We're continuing to develop the resource and are always happy to receive contributions via [our GitHub repository](https://github.com/rsetoolkit/rsetoolkit). You can [open an issue](https://github.com/RSEToolkit/RSEToolkit.github.io/issues/new/choose) if there's some content you'd like us to add, or you can contribute content directly by following our [contributing guidelines]({{ site.baseurl }}{% link contributing.md %}).
2525
{: .notice--info}
@@ -30,11 +30,10 @@ The RSE Toolkit (RTK) is intended to be a community developed resource for Resea
3030
- ###### [Training Hub]({{ site.baseurl }}{% link _pages/training/training.md %})
3131
- ###### [Research Hub]({{ site.baseurl }}{% link _pages/research/research.md %})
3232
- ###### [Subject Guide]({{ site.baseurl }}{% link _pages/subjectguide/guide.md %})
33-
- ###### rtk
3433

3534
## Why RTK?
3635

37-
This started out as an idea quite some time ago - indeed the (until recently empty) GitHub repository was created a while back with a view to developing this resource! The RSE community in the UK and beyond has been developing rapidly with groups and communities being started and growing at quite a pace as the interest in research software engineering continues to increase. This resource is intended to support this growth and provide a place where community members can link to their own materials or collaboratively develop new materials.
36+
The RSE community in the UK and beyond has been developing rapidly with groups and communities being started and growing at quite a pace as the interest in research software engineering continues to increase. This resource is intended to support this growth and provide a place where community members can link to their own materials or collaboratively develop new materials.
3837

3938
There is a wealth of information out there but with so much information, it can sometimes be difficult to find what we're looking for, or more generally, to find a summary of the things it is useful to know or be aware of as an RSE.
4039

@@ -52,9 +51,10 @@ The core set of resources that RTK is aiming to develop initially is:
5251

5352
- **[Research Hub]({{ site.baseurl }}{% link _pages/research/research.md %}):** Information on RSE-related research resources, how to get research credit for your RSE work if you're a research-focused RSE and advice and links to resources to help develop your research profile as an RSE.
5453

55-
- **rtk:** A Python command line tool with pluggable modules for undertaking common RSE tasks - develop and contribute your own modules or help to extend existing code.
56-
57-
The RTK resources will be available through the GitHub pages site for RTK and can be accessed at [https://github.com/RSEToolkit/RSEToolkit.github.io](https://github.com/RSEToolkit/RSEToolkit.github.io).
54+
- **[Subject Guides]({{ site.baseurl }}{% link _pages/subjectguide/guide.md %}):** Are you about
55+
to start a new project in a field that you've not previously worked in? Want a quick overview
56+
of the field? Want to know where to look for some helpful information? Check out our
57+
[subject guides]({{ site.baseurl }}{% link _pages/subjectguide/guide.md %}).
5858

5959
## Code of Conduct
6060

docs/_pages/research/research.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ layout: single
77

88
# Research Resources
99

10-
Details of research resources for RSEs.
10+
Details of research resources for RSEs.
11+
12+
{% include can-you-help.html %}

docs/_pages/roles/experienced-rse.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,28 @@ layout: single
77

88
## Research Resources
99

10-
Details of research resources for RSEs.
10+
A guide for experienced RSEs:
1111

12-
A guide for experienced RSEs.
12+
- Following best practices for research software engineering
13+
- Project structures
14+
- Version control
15+
- Licensing
16+
- Testing
17+
- Managing errors, issues, contributions, etc.
18+
- CI/CD
19+
- ...
20+
21+
- RSE team structures
22+
- Managing projects
23+
- Managing RSEs
24+
- Language guides and resources
25+
- Python
26+
- R
27+
- C/C++
28+
- Java
29+
- FORTRAN
30+
- JavaScript
31+
- Go
32+
- Rust
33+
34+
{% include can-you-help.html %}

docs/_pages/roles/new-rse.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,12 @@ layout: single
77

88
## Research Resources
99

10-
Details of research resources for RSEs.
11-
1210
A guide introducing RSE to newcomers to the field
1311

14-
What is an RSE?
12+
- What is an RSE?
13+
- Where are RSEs based? (central teams, embedded in research groups, etc.)
14+
- Where to look for RSE jobs
15+
- Pointers to information on core skills, best practices, etc.
16+
- ...
17+
18+
{% include can-you-help.html %}

docs/_pages/roles/researcher.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ layout: single
77

88
# Research Resources
99

10-
Details of research resources for RSEs.
10+
A guide for researchers and academics building or working with research
11+
software.
1112

12-
A guide for researchers and academics building or working with research software.
13+
- Researcher or RSE?<br/><small>How does the work that RSEs do differ
14+
from researchers who write code?</small>
15+
- Publishing software outputs
16+
- Licensing research software
17+
- Ensuring reproducibilty of computational research
18+
- Sharing and archiving code
19+
- Developing a community around your software outputs
20+
- ...
21+
22+
{% include can-you-help.html %}

docs/_pages/softdev/softdev.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ layout: single
77

88
### Software Development Resources
99

10-
Details of research resources for RSEs.
10+
Details of software development resources for RSEs.
11+
12+
{% include can-you-help.html %}

docs/_pages/subjectguide/guide.md

+1
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ Guides for RSEs new to working in a range of different domains
1111

1212
We have prepared some example guides for the following subjects.
1313

14+
{% include can-you-help.html %}

docs/_pages/tech/tech.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ layout: single
77

88
# Technical Resources
99

10-
Details of technical resources for RSEs.
10+
Details of technical resources for RSEs.
11+
12+
{% include can-you-help.html %}

docs/_pages/training/training.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ layout: single
77

88
# Training Resources
99

10-
Details of training resources for RSEs.
10+
Details of training resources for RSEs.
11+
12+
{% include can-you-help.html %}

0 commit comments

Comments
 (0)