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
refactor: ♻️ update roadmap based on latest changes (#347)
# Description
Update the roadmap, move some things into "hidden" state to simplify
amount of stuff, created an examples section, and removed any
course/workshop stuff (that is in rostools only now).
Closes#308Closes#316 (not it's own page, but a section for now)
This PR needs a quick review.
## Checklist
- [x] Formatted Markdown
- [x] Ran `just run-all`
---------
Co-authored-by: martonvago <57952344+martonvago@users.noreply.github.com>
| {{< 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. |
60
-
| {{< var status.planned >}} |`seedcase-project/check-datapackage`: Check the correctness of a `datapackage.json` file. |
| {{< var status.done >}} |[`seedcase-sprout`](https://github.com/seedcase-project/seedcase-sprout): Grow structured, organised, and usable data. |
60
+
| {{< var status.planned >}} |`check-datapackage`: Check the correctness of a `datapackage.json` file. |
61
61
| {{< var status.planned >}} |`seedcase-flower`: Cataloging and browsing metadata within a data package. |
62
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/). |
63
63
| {{< var status.planned >}} |`seedcase-propagate`: Submitting requests for accessing specific data from a data package. |
@@ -68,10 +68,11 @@ support research software and data engineering.
| {{< 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. |
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. |
74
-
| {{< var status.ongoing >}} |[`seedcase-project/spaid`](https://github.com/seedcase-project/spaid): A toolkit for developing Seedcase projects. |
| {{< var status.wip >}} |[`template-data-package`](https://github.com/seedcase-project/template-data-package): A template for setting up a data package following the Seedcase structure. |
73
+
| {{< var status.wip >}} |[`template-python-package`](https://github.com/seedcase-project/template-python-package): A template repository to use when making a Python package for Seedcase. |
74
+
| {{< var status.ongoing >}} |[`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. |
75
+
| {{< var status.ongoing >}} |[`spaid`](https://github.com/seedcase-project/spaid): A toolkit for developing Seedcase projects. |
75
76
76
77
: "Wishlist" of software-related products.
77
78
:::
@@ -80,17 +81,19 @@ support research software and data engineering.
80
81
81
82
Following the [diátaxis](https://diataxis.fr/) method, we split
82
83
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:
84
+
explanation. Right now, we don't create any tutorials, so only the other
85
+
three are listed below. A brief description of these types are expanded
86
+
upon in the sections below. These technical documentation products reach
87
+
MVP and done status when they are either:
86
88
87
89
- Uploaded to an archive like Zenodo (to generate a DOI).
88
90
- Taught to participants in a workshop setting.
89
91
- Uploaded to a software archive (like PyPI) if they are within a
90
92
software product's repository and are executable (the code within
91
93
runs).
92
94
93
-
::::: panel-tabset
95
+
::::::: panel-tabset
96
+
::: content-hidden
94
97
#### Tutorials
95
98
96
99
Tutorials are learning-oriented documentation that includes workshops,
| {{< 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
106
| {{< var status.potential >}} | Workshop: Introduction to building research software using Python as a solo developer in research environments. |
106
107
| {{< var status.potential >}} | Workshop: Iterative project management and development for effective collaboration and work. |
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. |
108
108
| {{< var status.potential >}} | Workshop: Building research software using Python in a team setting. |
109
109
110
110
: "Wishlist" of learning-type documentation products.
| {{< var status.wip >}} |[`guidebook.seedcase-project.org`](https://guidebook.seedcase-project.org/): Guidebook to doing research software engineering in a team-setting. |
120
122
| {{< var status.wip >}} |[`sprout.seedcase-project.org`](https://sprout.seedcase-project.org/docs/guide) usage guide: Using and interacting with `seedcase-sprout`. |
121
123
| {{< var status.planned >}} | Flower usage guide: Using and interacting with `seedcase-flower`. |
122
124
| {{< var status.planned >}} | Propagate usage guide: Using and interacting with `seedcase-propagate`. |
123
125
| {{< var status.planned >}} | Garden usage guide: Using and interacting with `seedcase-garden`. |
124
-
| {{< var status.planned >}} | Improving the research software development lifecycle by integrating DevOps practices. |
125
-
| {{< var status.planned >}} | A guided walkthrough: Team-based collaborative practices and workflows in a research environment. |
126
-
| {{< var status.potential >}} | Sprout data extensions usage guide: Installing or creating extensions for `seedcase-sprout`. |
127
-
| {{< var status.potential >}} | A guided walkthrough: Iterative and incremental project development and management in a research environment. |
128
-
| {{< var status.potential >}} | Using DocOps workflows and infrastructure to reduce time between writing and dissemination. |
129
-
| {{< var status.potential >}} | Building DataOps pipelines and infrastructure for improving research data quality and reduce time from collection to analysis. |
130
-
| {{< var status.potential >}} | Integrating research operations in organizations to improve quality and speed up research. |
126
+
| {{< var status.planned >}} | Shears usage guide: Using and interacting with `seedcase-shears`. |
131
127
132
128
: "Wishlist" of goal-type documentation products.
133
129
130
+
::: content-hidden
131
+
Potentials:
132
+
133
+
- Improving the research software development lifecycle by integrating
134
+
DevOps practices.
135
+
- A guided walkthrough: Team-based collaborative practices and
136
+
workflows in a research environment.
137
+
- Using DocOps workflows and infrastructure to reduce time between
138
+
writing and dissemination.
139
+
- Building DataOps pipelines and infrastructure to improve research
140
+
data quality and reduce time from collection to analysis.
141
+
- Integrating research operations in organizations to improve quality
142
+
and speed up research.
143
+
:::
144
+
134
145
#### Reference
135
146
136
147
Reference material is information-oriented documentation that are
@@ -149,12 +160,10 @@ products are all classified as "ongoing".
| {{< var status.ongoing >}} |[`seedcase-project/seedcase-sprout`](https://sprout.seedcase-project.org/docs/reference/): Reference docs for Sprout. |
153
-
| {{< var status.ongoing >}} |[`seedcase-project/design`](https://github.com/seedcase-project/design): Overall architectural design documentation for Seedcase software. |
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. |
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. |
156
-
| {{< var status.ongoing >}} |[`seedcase-project/seedcase-website`](https://github.com/seedcase-project/seedcase-website): Main website for the Seedcase Project. |
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. |
163
+
| {{< var status.ongoing >}} |[`seedcase-sprout`](https://sprout.seedcase-project.org/docs/reference/): Reference docs for Sprout. |
164
+
| {{< var status.ongoing >}} |[`design`](https://github.com/seedcase-project/design): General design principles and patterns for the organisation, teams, software, and data used throughout the Seedcase Project. |
165
+
| {{< var status.ongoing >}} |[`team`](https://github.com/seedcase-project/team): Documentation specific to the Seedcase team, like onboarding, common configuration files, and meeting agendas and minutes. |
166
+
| {{< var status.ongoing >}} |[`seedcase-website`](https://github.com/seedcase-project/seedcase-website): Main website for the Seedcase Project. |
158
167
159
168
: "Wishlist" of informational-type documentation products.
160
169
@@ -169,8 +178,8 @@ pieces, and outreach materials.
| {{< var status.ongoing >}} |[`seedcase-project/community`](https://github.com/seedcase-project/community): Sharing knowledge and skills learned from attending conferences and workshops in research software and data engineering or operational management|
173
-
| {{< var status.ongoing >}} |[`seedcase-project/decisions`](https://github.com/seedcase-project/decisions): Archival records on the decisions made for tools or processes we use in the Seedcase Project. |
181
+
| {{< var status.ongoing >}} |[`community`](https://github.com/seedcase-project/community): Content for community building, outreach, and news about the Seedcase Project.|
182
+
| {{< var status.ongoing >}} |[`decisions`](https://github.com/seedcase-project/decisions): Archival records of decisions made about tools or processes we use in the Seedcase Project. |
174
183
| {{< var status.potential >}} | Research data engineering: What is it and why is it vital for modern research? |
175
184
| {{< var status.potential >}} | Challenges and barriers: Workflows and digital infrastructure for building software in a team-based research environment. |
176
185
@@ -183,8 +192,21 @@ pieces, and outreach materials.
183
192
| {{< var status.potential >}} | Researchers don't know how to effectively work together: Current challenges and potential solutions. |
184
193
| {{< var status.potential >}} | Research institutions and funding agencies are not yet designed to support effective and robust, and therefore vital, research software development. |
185
194
:::
186
-
:::::
195
+
:::::::
196
+
197
+
### Examples that use our products
198
+
199
+
These are practical examples of how to use Seedcase software to
200
+
structure datasets and prepare them to be used by others. The data is
| {{< var status.ongoing >}} |[`example-rhesus-monkeys`](https://github.com/seedcase-project/example-rhesus-monkeys): Example repository for making a data package with data from a study of maternal obesity in rhesus monkeys |
206
+
| {{< var status.ongoing >}} |[`example-seed-beetle`](https://github.com/seedcase-project/example-seed-beetle): Example repository for making a data package with data from a study of complex mitonuclear interactions and metabolic costs of mating in male seed beetles |
207
+
| {{< var status.ongoing >}} |[`example-rainforest`](https://github.com/seedcase-project/example-rainforest): Example repository for making a data package with data from a study of seed germination in the rainforest |
187
208
209
+
:::: content-hidden
188
210
### Outreach and events
189
211
190
212
These are activities involves engaging with the research community,
@@ -204,6 +226,7 @@ research community about the various topics we work on and advocate for.
204
226
| {{< var status.potential >}} | Symposium: Current state of data engineering in research environment |
205
227
206
228
: "Wishlist" of outreach event "products".
229
+
::::
207
230
208
231
## Collaborations and users
209
232
@@ -212,7 +235,7 @@ deliverables, we aim to test and deploy them in real-world projects. We
212
235
have several potential projects lined up for this:
0 commit comments