From e865979b97f1d640a5fe6ead859a48dc0ec6106b Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Sat, 2 Nov 2024 13:55:52 +0100 Subject: [PATCH 1/6] docs: :memo: link to the roadmap on GitHub project board --- roadmap.qmd | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/roadmap.qmd b/roadmap.qmd index d2a12f1..9578ba5 100644 --- a/roadmap.qmd +++ b/roadmap.qmd @@ -17,10 +17,12 @@ 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). + +::: 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 From 0576cc0f6525b0332a1b623a4d971c6cd8babfd3 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Sat, 2 Nov 2024 13:57:15 +0100 Subject: [PATCH 2/6] docs: :memo: remove sign-in deliverable and update timelines for software --- roadmap.qmd | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/roadmap.qmd b/roadmap.qmd index 9578ba5..8291368 100644 --- a/roadmap.qmd +++ b/roadmap.qmd @@ -36,15 +36,14 @@ 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 | - -: Approximate timeline for completion of a minimum viable product +| 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 timelines for completion of a minimum viable product (prototype). ### Documentation From c83c40319974582c60bbfbb09306b8db2580dce2 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Sat, 2 Nov 2024 13:57:45 +0100 Subject: [PATCH 3/6] docs: :memo: update documentation roadmap to include usage guides --- roadmap.qmd | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/roadmap.qmd b/roadmap.qmd index 8291368..33a404c 100644 --- a/roadmap.qmd +++ b/roadmap.qmd @@ -50,19 +50,22 @@ progresses. 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. +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 | +| 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. From b76fae4bdc741c9ce30744d876ef9278e9233134 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Sat, 2 Nov 2024 14:10:56 +0100 Subject: [PATCH 4/6] docs: :memo: convert doc deliverables into table, moved opinion paper to this table --- roadmap.qmd | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/roadmap.qmd b/roadmap.qmd index 33a404c..8c4e20d 100644 --- a/roadmap.qmd +++ b/roadmap.qmd @@ -96,10 +96,13 @@ 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 From 9a769879962abe8c30d396772b3d326daf6b8d44 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Sat, 2 Nov 2024 14:11:45 +0100 Subject: [PATCH 5/6] docs: :memo: remove `r-cubed-ise` and replace with project dev course --- roadmap.qmd | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/roadmap.qmd b/roadmap.qmd index 8c4e20d..b4c904f 100644 --- a/roadmap.qmd +++ b/roadmap.qmd @@ -106,13 +106,13 @@ 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. From 450b6f3c53f05854238de19625536ebc17415744 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Sat, 2 Nov 2024 14:12:09 +0100 Subject: [PATCH 6/6] style: :art: reformat Markdown --- roadmap.qmd | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/roadmap.qmd b/roadmap.qmd index b4c904f..2a57977 100644 --- a/roadmap.qmd +++ b/roadmap.qmd @@ -13,10 +13,14 @@ 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). ::: callout-tip Check out our more detailed, regularly updated, and evolving @@ -37,7 +41,7 @@ timeline below is an approximation and may change as the project progresses. | 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. | @@ -49,13 +53,13 @@ progresses. ### Documentation While we want the software products to have a more tangible deliverable -and timeline, we will be continually updating and refining related +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. | @@ -73,7 +77,7 @@ 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 | @@ -86,12 +90,12 @@ 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 @@ -134,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