Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: 📝 update roadmap #61

Merged
merged 6 commits into from
Nov 4, 2024
Merged

docs: 📝 update roadmap #61

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e865979
docs: :memo: link to the roadmap on GitHub project board
lwjohnst86 Nov 2, 2024
0576cc0
docs: :memo: remove sign-in deliverable and update timelines for soft…
lwjohnst86 Nov 2, 2024
c83c403
docs: :memo: update documentation roadmap to include usage guides
lwjohnst86 Nov 2, 2024
b76fae4
docs: :memo: convert doc deliverables into table, moved opinion paper…
lwjohnst86 Nov 2, 2024
9a76987
docs: :memo: remove `r-cubed-ise` and replace with project dev course
lwjohnst86 Nov 2, 2024
450b6f3
style: :art: reformat Markdown
lwjohnst86 Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 60 additions & 47 deletions roadmap.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,20 @@ Because of the evolving nature of developing software, the software
product is never "completed" as it continues to be improved on and
updated. So here we define a **deliverable** for software as the first
minimum viable product (or prototype). After the first release of a
minimum viable product, the software product will continue to be
tested and refined based on user feedback, identified bugs, and additional
minimum viable product, the software product will continue to be tested
and refined based on user feedback, identified bugs, and additional
features.

Likewise, our documentation and training/education projects will also continue to be refined and
updated. So we define a deliverable as the first time they are uploaded to
an archive (like a software release) to create a DOI (digital object
identifier).
Likewise, our documentation and training/education projects will also
continue to be refined and updated. So we define a deliverable as the
first time they are uploaded to an archive (like a software release) to
create a DOI (digital object identifier).

::: callout-tip
Check out our more detailed, regularly updated, and evolving
[roadmap](https://github.com/orgs/seedcase-project/projects/22/views/1)
that's organized as a GitHub Project Board.
:::

## Primary deliverables

Expand All @@ -34,42 +40,44 @@ implementation based on changing technical needs and resources. The
timeline below is an approximation and may change as the project
progresses.

| Status | Timeline | Deliverable | Description |
|-----------------|------------------|---------------------|------------------|
| {{< var status.wip >}} | Mid-to-end 2024 | [`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. |
| {{< var status.wip >}} | Concurrent with Sprout | Built-in to Sprout | Authenticating users and managing permissions |
| {{< var status.planned >}} | Mid 2025 | `seedcase-flower` | Cataloging and browsing metadata on data in a Data Resource |
| {{< var status.planned >}} | Early 2026 | `seedcase-propogate` | Submitting request for accessing specific data from a Data Resource |
| {{< var status.planned >}} | End 2026 | `seedcase-garden` | Tend to projects using data from a Data Resource |
| Status | Timeline | Deliverable | Description |
|------------------|------------------|-------------------|------------------|
| {{< var status.wip >}} | Mid-to-end 2025 | [`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. |
| {{< var status.planned >}} | End 2025 | `seedcase-flower` | Cataloging and browsing metadata on data in a data package. |
| {{< var status.planned >}} | Mid 2026 | `seedcase-propogate` | Submitting request for accessing specific data from a data package. |
| {{< var status.planned >}} | Early 2027 | `seedcase-garden` | Tend to and track projects using data from a data package. |

: Approximate timeline for completion of a minimum viable product
: Approximate timelines for completion of a minimum viable product
(prototype).

### Documentation

While we want the software products to have a more tangible deliverable
and timeline, we will be continually updating and refining related
documentation. At some regular intervals, we plan on uploading the documents
to an archive for generating DOIs and for greater dissemination.

| Status | Timeline | Deliverable | Description |
|-----------------|-----------------|------------------|----------------------|
| {{< var status.wip >}} | End 2025 | [`seedcase-project/decisions`](https://github.com/seedcase-project/decisions) | Archival records on many of the decisions made in the Seedcase Project
|
| {{< var status.wip >}} | End 2025 | [`seedcase-project/design`](https://github.com/seedcase-project/design) | Overall architectural design documentation for Seedcase software. |
| {{< var status.wip >}} | End 2026 | [`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. |
| {{< var status.wip >}} | Not relevant | [`seedcase-project/community`](https://github.com/seedcase-project/community) | Content for community building, outreach, and contributing guidelines for the Seedcase Project |
| {{< var status.wip >}} | Not relevant | [`seedcase-project/seedcase-website`](https://github.com/seedcase-project/seedcase-website) | Main website for the Seedcase Project |
| {{< var status.planned >}} | TBD | Usage guides | General guides for using and interacting with Seedcase software |
| {{< var status.planned >}} | TBD | Opinion paper | Workflows and digital infrastructure for building software in a team-based research environment |
and timeline, we will be continually updating and refining related
documentation. At some regular intervals, we plan on uploading the
documents to an archive for generating DOIs and for greater
dissemination.

| Status | Timeline | Deliverable | Description |
|------------------|------------------|------------------|--------------------|
| {{< var status.wip >}} | Ongoing | [`seedcase-project/decisions`](https://github.com/seedcase-project/decisions) | Archival records on many of the decisions made in the Seedcase Project |
| | | | |
| {{< var status.wip >}} | Ongoing | [`seedcase-project/design`](https://github.com/seedcase-project/design) | Overall architectural design documentation for Seedcase software. |
| {{< var status.wip >}} | 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. |
| {{< var status.wip >}} | Ongoing | [`seedcase-project/community`](https://github.com/seedcase-project/community) | Content for community building, outreach, and contributing guidelines for the Seedcase Project |
| {{< var status.wip >}} | Ongoing | [`seedcase-project/seedcase-website`](https://github.com/seedcase-project/seedcase-website) | Main website for the Seedcase Project |
| {{< var status.wip >}} | Early-to-mid 2025 | [`sprout.seedcase-project.org`](https://sprout.seedcase-project.org/guide) usage guide | Guide for using and interacting with `seedcase-sprout`. |
| {{< var status.wip >}} | Late 2025 | Flower usage guide | Guide for using and interacting with `seedcase-flower` |
| {{< var status.wip >}} | Mid 2026 | Propagate usage guide | Guide for using and interacting with `seedcase-propagate` |
| {{< var status.wip >}} | Late 2026 | Garden usage guide | Guide for using and interacting with `seedcase-garden` |

: List of documentation deliverables with approximate timelines for
uploading to an archive for the first time.

### Training and education

| Status | Timeline | Deliverable | Description |
|--------|----------|-------------|-------------|
|------------------|------------------|-------------------|-------------------|
| {{< var status.planned >}} | TBD | Tutorial | Installing and setting up Seedcase on a server so Data Resources can be created |
| {{< var status.planned >}} | TBD | Tutorial | Using Seedcase to create and manage a Data Resource |
| {{< var status.planned >}} | TBD | Tutorial | Requesting to start a data project for a Data Resource |
Expand All @@ -82,30 +90,33 @@ uploading to an archive for the first time.
::: panel-tabset
### Software

| Status | Timeline | Deliverable | Description |
|-----------------|-----------------|------------------|----------------------|
| {{< var status.planned >}} | TBD | Sprout data processing plug-in | Plugin/extension system for Seedcase Sprout processing or enriching data |
| {{< var status.potential >}} | TBD | Theme customization extensions | Plugin/extension system for theming of user interface elements of all Seedcase software |
| Status | Timeline | Deliverable | Description |
|------------------|------------------|------------------|--------------------|
| {{< var status.planned >}} | TBD | Sprout data processing plug-in | Plugin/extension system for Seedcase Sprout processing or enriching data |
| {{< var status.potential >}} | TBD | Theme customization extensions | Plugin/extension system for theming of user interface elements of all Seedcase software |

: Secondary software deliverables with their approximate timeline for
: Secondary software deliverables with their approximate timelines for
completion of a minimum viable product (prototype) for each.

### Documentation

- Knowledge and skills learned from attending conferences and
workshops in research software and data engineering or operational
management (via the
[Community](https://community.seedcase-project.org/))
| Status | Timeline | Deliverable | Description |
|------------------|------------------|------------------|--------------------|
| {{< var status.wip >}} | Ongoing | Knowledge sharing via the [Community](https://community.seedcase-project.org/) website | Knowledge and skills learned from attending conferences and workshops in research software and data engineering or operational management |
| {{< var status.planned >}} | TBD | Opinion paper | Workflows and digital infrastructure for building software in a team-based research environment |

: Secondary documentation deliverables with their approximate timelines for
uploading to an archive for the first time.

### Training and education

| Status | Timeline | Deliverable | Description |
|-----------------|-----------------|------------------|----------------------|
| {{< var status.wip >}} | Mid-2025 | [`rostools/r-pkg-intro`](https://github.com/rostools/r-pkg-intro) | An introduction course to building R Packages |
| {{< var status.wip >}} | Mid-2025 | [`rostools/r-cubed-ise`](https://github.com/rostools/r-cubed-ise) | An course to do reproducible research in server environments with R |
| {{< var status.planned >}} | End 2025 | [`rostools/cog-flow-intro`](https://github.com/rostools/cog-flow-intro) | :gear: Collaboration with Git and GitHub: A gentle introduction to a team-based collaborative workflow using Git and GitHub. |
| {{< var status.potential >}} | TBD | Seminar series | What is research data engineering? |
| {{< var status.potential >}} | TBD | Workshop | Data engineering in a research environment |
| Status | Timeline | Deliverable | Description |
|------------------|------------------|------------------|--------------------|
| {{< var status.wip >}} | Mid-2025 | [`rostools/r-pkg-intro`](https://github.com/rostools/r-pkg-intro) | An introduction course to building R Packages |
| {{< var status.planned >}} | End 2025 | [`rostools/cog-flow-intro`](https://github.com/rostools/cog-flow-intro) | :gear: Collaboration with Git and GitHub: A gentle introduction to a team-based collaborative workflow using Git and GitHub. |
| {{< var status.potential >}} | TBD | Course on project development | Introductory course on iterative project management and development for effective collaboration and work. |
| {{< var status.potential >}} | TBD | Seminar series | What is research data engineering? |
| {{< var status.potential >}} | TBD | Workshop | Data engineering in a research environment |

: List of secondary deliverables with approximate timelines for running
the first workshop or course.
Expand All @@ -127,8 +138,10 @@ have several projects lined up for this:

- [DD2](https://dd2.dk/)
- [ADDITION](https://addition.au.dk/)
- [Health in Central Region](https://www.stenoaarhus.dk/tvarsektoriel-forskning/helbred-i-midt/)
- [DARTER](https://steno-aarhus.github.io/darter-project/) (register-based research project at Steno)
- [Health in Central
Region](https://www.stenoaarhus.dk/tvarsektoriel-forskning/helbred-i-midt/)
- [DARTER](https://steno-aarhus.github.io/darter-project/)
(register-based research project at Steno)

We also have several projects that act as infrastructural support for
the Seedcase Project, all of which are continually developed and are not
Expand Down