You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: finance/proposal-calls/cycle3/user-dev-support-rse.md
+61-8Lines changed: 61 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,26 +4,79 @@ Research Software Engineer: User and Developer Support
4
4
5
5
### Project Team
6
6
7
-
TBD
7
+
- Adrian Price-Whelan
8
+
- TBD (please add your name if you would be interested in helping manage or coordinate
9
+
this role!)
8
10
9
11
### Project Description
10
12
11
-
A research software engineer (RSE) position with an equivalent ~50% FTE appointment to tackle both user-facing and developer-facing support issues.
13
+
A research software engineer (RSE) position with an equivalent ~50% FTE appointment to
14
+
tackle both user-facing and developer-facing support issues, as identified and
15
+
prioritized by the Astropy community and infrastructure teams. The RSE would have a
16
+
"manager" who is an existing Astropy contributor with existing knowledge of the Astropy
17
+
core package, ecosystem, infrastructure packages, and community. The RSE is expected to
18
+
eventually work independently, but with feedback from the Manager and Astropy community.
12
19
13
20
### Project / Work
14
21
22
+
The broad scope of work for the RSE includes any efforts to support both Astropy users
23
+
and contributors, including, for a few general examples, update the Astropy core
24
+
documentation theme, automate release procedures for infrastructure packages, or
25
+
implement more specific projects related to Astropy core subpackages (some examples
26
+
given below).
27
+
28
+
The RSE position is distinct from the Software Operational Support Specialist (SOSS)
29
+
position in that the RSE is expected to take on and complete discrete *projects*, rather
30
+
than provide continuous support (e.g., monitoring issues, helping new contributors,
31
+
etc., as was included in the SOSS scope of work).
32
+
33
+
The exact projects that the RSE tackles and detailed implementation plans should be
34
+
discussed, prioritized, and fleshed out by the Astropy community and RSE together if
35
+
this funding request is accepted. A few possible projects are included below as
36
+
examples, some drawn from the [Astropy
37
+
Roadmap](https://github.com/astropy/astropy-project/blob/main/roadmap/roadmap.md), but
38
+
these should not be considered as the exact plan of work for the RSE — the RSE will work
39
+
independently, so some aspects of project priority will stem from their expertise and
40
+
interest.
41
+
15
42
Example projects:
16
-
* Overhaul the Astropy developer documentation to include entry points for contributors with different skill levels.
17
-
* Review the full Astropy documentation; research best practices in software documentation and implement changes to the structure of the docs, or propose a path toward overhauling the docs layout and structure to match best practices.
18
-
* Support maintenance of Astropy coordinated (and other affiliated) packages and project infrastructure.
19
-
* TBD
43
+
**Restructure the Astropy developer documentation*: The current developer documentation
44
+
pages have a wealth of content aimed at both new contributors and expert technical
45
+
engineers, but it is mixed and hard for contributors with different skill levels to
46
+
easily find the content most appropriate for them. The goal of this project is to
47
+
restructure the documentation pages to provide easier pathways for potential or
48
+
existing contributors with different skill levels to find relevant developer
49
+
documentation they need to make a contribution. Relevant issues:
0 commit comments