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
| {{< var status.done >}} | Products we have completed a minimally viable product (MVP) of. As products are never truly "done", the "done" status simply indicates that the product is now in a usable state, but that we will continue improving and working on it. |
49
-
| {{< var status.wip >}} | Products we are currently working on. |
50
-
| {{< var status.planned >}} | Products we plan to work on and aim to complete within the current funding period (end of 2027). |
51
-
| {{< var status.potential >}} | Products we are very interested in working on, but given the time and resources, may likely not get to within the current funding period (end of 2027).|
52
-
| {{< var status.ongoing >}} |Products that we will continually work on and that don't strictly have a defined endpoint for "done" (e.g. aren't ever released or uploaded to an archive). |
35
+
| {{< var status.done >}} | Products we've completed with a minimally viable product (MVP) that we'll continue to improve and work on. |
36
+
| {{< var status.wip >}} | Products we are working on currently. |
37
+
| {{< var status.planned >}} | Products we plan to complete within the current funding period (end of 2027). |
38
+
| {{< var status.potential >}} | Products we'd like to work on, but probably won't finish within the current funding period (end of 2027) due to limited time and resources,|
39
+
| {{< var status.ongoing >}} |Ongoing products without a final release (e.g., not archived or officially published). |
53
40
54
41
### Software and software-related
55
42
56
-
Because of the evolving nature of developing software, software products
57
-
are rarely "complete", as they continue to be improved on and updated.
58
-
The product reaches MVP and done status when we have created its first
59
-
release on an official software archive (like PyPI for Python packages).
60
-
After the first release of a MVP and if it gets sufficient use, it will
61
-
continue to be tested and refined based on user feedback and identified
62
-
bugs.
43
+
Because software development is an ongoing process, software products
44
+
are rarely truly "complete". They continue to evolve through updates and
45
+
improvements. A product is considered to have reached MVP and "done"
46
+
status once its first version is released on an official software
47
+
archive (like PyPI for Python packages). If the product gets sufficient
48
+
use, it will continue to be tested and refined based on user feedback.
63
49
64
-
Some of these products are not strictly software, but can be used within
65
-
a software environment, can be integrate into other workflows, or are
66
-
used to support research software and data engineering.
50
+
Some of these products are not strictly software, but are designed to
51
+
work within software environments, integrate with other workflows, or
| {{< var status.wip >}} |[`seedcase-project/seedcase-sprout`](https://github.com/seedcase-project/seedcase-sprout): Upload your research data to formally structure it for better, more reliable, and easier research. |
74
60
| {{< var status.planned >}} |`seedcase-project/check-datapackage`: Check the correctness of a `datapackage.json` file. |
75
61
| {{< var status.planned >}} |`seedcase-flower`: Cataloging and browsing metadata within a data package. |
76
62
| {{< var status.planned >}} |`seedcase-shears`: Processing raw data into a [Tidy](https://vita.had.co.nz/papers/tidy-data.pdf)[Polars DataFrame](https://pola.rs/). |
77
63
| {{< var status.planned >}} |`seedcase-propagate`: Submitting requests for accessing specific data from a data package. |
78
64
| {{< var status.planned >}} |`seedcase-garden`: Tend to and track projects using data from a data package. |
79
65
80
-
: "Wishlist" of software products we are currently working on, will work
| {{< var status.ongoing >}} |[`seedcase-project/seedcase-theme`](https://github.com/seedcase-project/seedcase-theme): Template repository for website projects with a Seedcase-specific Quarto extension for aesthetics, helper commands, and infrastructural files. |
| {{< var status.ongoing >}} |[`seedcase-project/seedcase-theme`](https://github.com/seedcase-project/seedcase-theme): Template repository for website projects with a Seedcase-specific Quarto extension for aesthetics and infrastructural files. |
88
73
| {{< var status.ongoing >}} |[`seedcase-project/template-python-project`](https://github.com/seedcase-project/template-python-project): A template repository to use when making a Python project for Seedcase. |
89
74
| {{< var status.ongoing >}} |[`seedcase-project/spaid`](https://github.com/seedcase-project/spaid): A toolkit for developing Seedcase projects. |
90
75
91
-
: "Wishlist" of software-related products we are currently working on,
92
-
will work on, or hope to work on.
76
+
: "Wishlist" of software-related products.
93
77
:::
94
78
95
79
### Technical documentation
96
80
97
-
Following the [diátaxis](https://diataxis.fr/) method to structuring
98
-
documentation, documentation is split up into four types: tutorials,
99
-
how-to guides, reference, and explanation. A brief description of these
100
-
types of documentation are expanded upon in the sections below. These
101
-
technical documentation products reach MVP and done status when they are
102
-
either:
81
+
Following the [diátaxis](https://diataxis.fr/) method, we split
82
+
documentation into four types: tutorials, how-to guides, reference, and
83
+
explanation. A brief description of these types are expanded upon in the
84
+
sections below. These technical documentation products reach MVP and
85
+
done status when they are either:
103
86
104
87
- Uploaded to an archive like Zenodo (to generate a DOI).
105
-
- Taught to participants in a course setting.
88
+
- Taught to participants in a workshop setting.
106
89
- Uploaded to a software archive (like PyPI) if they are within a
107
90
software product's repository and are executable (the code within
108
91
runs).
109
92
110
93
::::: panel-tabset
111
94
#### Tutorials
112
95
113
-
Tutorials are learning-oriented documentation that includes multi-day
114
-
courses, online tutorials, and learning shorts. These will be developed
115
-
as [open educational
96
+
Tutorials are learning-oriented documentation that includes workshops,
97
+
online tutorials, and learning shorts. These will be developed as [open
| {{< var status.wip >}} |[`rostools/git4cats`](https://github.com/rostools/git4cats): 🐱 Git for Collaborative Teams: An introductory course on using Git and GitHub for team-based collaborative workflows and practices |
121
-
| {{< var status.potential >}} | Course: Introduction to building research software using Python as a solo developer in research environments. |
122
-
| {{< var status.potential >}} | Course: Iterative project management and development for effective collaboration and work. |
103
+
| {{< var status.done >}} |[`rostools/github-intro`](https://github.com/rostools/github-intro): An introductory workshop on using GitHub |
104
+
| {{< var status.wip >}} |[`rostools/git4cats`](https://github.com/rostools/git4cats): 🐱 Git for Collaborative Teams: An introductory workshop on using Git and GitHub for team-based collaborative workflows and practices |
105
+
| {{< var status.potential >}} | Workshop: Introduction to building research software using Python as a solo developer in research environments. |
106
+
| {{< var status.potential >}} | Workshop: Iterative project management and development for effective collaboration and work. |
123
107
| {{< var status.potential >}} |[`rostools/r-pkg-intro`](https://github.com/rostools/r-pkg-intro): Build research software using R as a solo developer in research environments. |
124
-
| {{< var status.potential >}} |Course: Building research software using Python in a team setting. |
108
+
| {{< var status.potential >}} |Workshop: Building research software using Python in a team setting. |
125
109
126
-
: "Wishlist" of learning-type documentation products we are currently
127
-
working on, will work on, or hope to work on.
110
+
: "Wishlist" of learning-type documentation products.
128
111
129
112
#### How-to guides
130
113
@@ -146,8 +129,7 @@ user manuals.
146
129
| {{< var status.potential >}} | Building DataOps pipelines and infrastructure for improving research data quality and reduce time from collection to analysis. |
147
130
| {{< var status.potential >}} | Integrating research operations in organizations to improve quality and speed up research. |
148
131
149
-
: "Wishlist" of goal-type documentation products we are currently
150
-
working on, will work on, or hope to work on.
132
+
: "Wishlist" of goal-type documentation products.
151
133
152
134
#### Reference
153
135
@@ -167,14 +149,14 @@ products are all classified as "ongoing".
| {{< var status.ongoing >}} |[`seedcase-project/seedcase-sprout`](https://sprout.seedcase-project.org/docs/reference/): Reference docs for Sprout. |
170
153
| {{< var status.ongoing >}} |[`seedcase-project/design`](https://github.com/seedcase-project/design): Overall architectural design documentation for Seedcase software. |
171
154
| {{< var status.ongoing >}} |[`seedcase-project/team`](https://github.com/seedcase-project/team): Documentation specific to the Seedcase team, like onboarding, common configuration files, and meeting agendas and minutes. |
172
155
| {{< var status.ongoing >}} |[`seedcase-project/community`](https://github.com/seedcase-project/community): Content for community building, outreach, and contributing guidelines for the Seedcase Project. |
173
156
| {{< var status.ongoing >}} |[`seedcase-project/seedcase-website`](https://github.com/seedcase-project/seedcase-website): Main website for the Seedcase Project. |
174
157
| {{< var status.ongoing >}} |[`seedcase-project/examples`](https://github.com/seedcase-project/examples): Practical examples of how to use Seedcase software to structure datasets and prepare them to be used by others. All data is either fake, synthetically generated, or completely open. |
175
158
176
-
: "Wishlist" of informational-type documentation products we are
177
-
currently working on, will work on, or hope to work on.
159
+
: "Wishlist" of informational-type documentation products.
178
160
179
161
#### Explanation
180
162
@@ -192,8 +174,7 @@ pieces, and outreach materials.
192
174
| {{< var status.potential >}} | Research data engineering: What is it and why is it vital for modern research? |
193
175
| {{< var status.potential >}} | Challenges and barriers: Workflows and digital infrastructure for building software in a team-based research environment. |
194
176
195
-
: "Wishlist" of explanation-type documentation products we are currently
196
-
working on, will work on, or hope to work on.
177
+
: "Wishlist" of explanation-type documentation products.
197
178
198
179
::: content-hidden
199
180
| Status | Deliverable |
@@ -206,9 +187,8 @@ working on, will work on, or hope to work on.
206
187
207
188
### Outreach and events
208
189
209
-
These are activities that would involve engaging with the research
210
-
community, mainly through in-person seminars, symposiums, or other
211
-
events.
190
+
These are activities involves engaging with the research community,
191
+
mainly through in-person seminars, symposiums, or other events.
212
192
213
193
::: callout-note
214
194
Given the expertise and resources needed for these types of "products"
@@ -223,8 +203,7 @@ research community about the various topics we work on and advocate for.
223
203
| {{< var status.potential >}} | Seminar series: Unmet needs for research data engineering and current challenges in implementation |
224
204
| {{< var status.potential >}} | Symposium: Current state of data engineering in research environment |
225
205
226
-
: "Wishlist" of outreach event "products" we are currently working on,
0 commit comments