From 77a39ab991dfde991a2f903784dc222ae7478623 Mon Sep 17 00:00:00 2001 From: Taylor Downs Date: Fri, 29 Nov 2024 15:36:23 +0000 Subject: [PATCH] remove numbers --- docs/contribute/openfn-roadmap.md | 73 +++++++++++++++---------------- 1 file changed, 35 insertions(+), 38 deletions(-) diff --git a/docs/contribute/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md index b8c2a982025..4bb21dbb812 100644 --- a/docs/contribute/openfn-roadmap.md +++ b/docs/contribute/openfn-roadmap.md @@ -46,15 +46,12 @@ immediate roadmap. ### See [**_Now_**](https://github.com/orgs/OpenFn/projects/3/views/1) 🚧 for what's been funded and is currently being built -### See [**_Next_**](https://github.com/orgs/OpenFn/projects/3/views/2) 📝 for what's being shaped and _may_ be funded in the next cycle - ### See [**_Epics_**](https://github.com/orgs/OpenFn/projects/3/views/7) 🤔 for a list of projects that we're considering, roughly-prioritized ### See [**_Bugs_**](https://github.com/orgs/OpenFn/projects/3/views/22) 🐞 for reported bugs -We will update this site periodically (ideally after each cycle, typically -lasting between 2-6 weeks) to reflect our progress on major items. You can also -keep track of all new features, changes, and bug fixes in our +We will update this site monthly to reflect our progress on major items. You can +also keep track of all new features, changes, and bug fixes in real-time via our [Changelog](https://openfn.github.io/lightning/changelog.html). ## How to **get involved** @@ -119,27 +116,27 @@ OpenFn/Lightning is the fully open-source workflow automation platform at the core of the OpenFn Digital Public Good (learn more about the product [here](/documentation#openfn-v2-lightning-)). -| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | -| ----------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1.Workflow snapshots | Delivered | Q3 '24 | [Issue 1680](https://github.com/OpenFn/lightning/issues/1680) | Keep a snapshot of a snapshot based on a run or saved changes of the workflow. Allow users to be able to view snapshot and switch to the latest version of the workflow from a snapshot mode. | -| 2.Configurable run concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2002) | Allow users to control the limit of concurrent runs per workflow in a project. | -| 3.Kafka workflow trigger | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | A new workflow trigger type that creates a new workorder when a Kafka message is received . | -| 4. Allow users to create new projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/lightning/issues/1700) | Allow users to create new projects from the project list page. | -| 4. Export work order history with logs and data clips | Delivered | Q3 '24 | [Issue 1698](https://github.com/OpenFn/lightning/issues/1698) | Allow project users to be able to export workorder history. The workorder history contains ALL logs and data clips (Input and Output) associated with runs in a workorder. | -| 5. Project datastores and buffers | Delivered | Q4 '24 | [Issue 2190](https://github.com/OpenFn/lightning/issues/2190) | Allow users to configure a data store or buffer that allows temporary of storage of data that can be used in a workflow. | -| 6. Make User Onboarding better with resources | Delivered | Q4 '24 | [Issue 2523](https://github.com/OpenFn/Lightning/issues/2523) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | -| 7. Snapshots and Audit Trail | In dev | Q4 '24 | [Issue 2526](https://github.com/OpenFn/Lightning/issues/2526) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | -| 8. Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | -| 9. Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | -| 10. OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | -| 11. Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | -| 12. Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | -| 13. Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | -| 14. Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | -| 15. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | -| 16. Enable sandbox and production modes | Tracked | Q1 '25 | [Issue 2524](https://github.com/OpenFn/Lightning/issues/2524) and [Issue 2525](https://github.com/OpenFn/Lightning/issues/2525) | Allow users to be able to switch between sandbox and production modes in their projects. | -| 17. Control log output and levels | Tracked | Q1 '25 | [Issue 1755](https://github.com/OpenFn/Lightning/issues/1755) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | -| 18. Enhanced websocket worker Monitoring | Tracked | Q1 '25 | [Issue 608](https://github.com/OpenFn/kit/issues/608) | Give users better visibility of what's happening on inside the worker, especially when an error occurs during run execution. | +| **Feature** | **Status** | **Timeline** | **Link(s)** | **Description** | +| ---------------------------------------------------- | ---------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| • Workflow snapshots | Delivered | Q3 '24 | [Issue 1680](https://github.com/OpenFn/lightning/issues/1680) | Keep a snapshot of a snapshot based on a run or saved changes of the workflow. Allow users to be able to view snapshot and switch to the latest version of the workflow from a snapshot mode. | +| • Configurable run concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2002) | Allow users to control the limit of concurrent runs per workflow in a project. | +| • Kafka workflow trigger | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | A new workflow trigger type that creates a new workorder when a Kafka message is received . | +| • Allow users to create new projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/lightning/issues/1700) | Allow users to create new projects from the project list page. | +| • Export work order history with logs and data clips | Delivered | Q3 '24 | [Issue 1698](https://github.com/OpenFn/lightning/issues/1698) | Allow project users to be able to export workorder history. The workorder history contains ALL logs and data clips (Input and Output) associated with runs in a workorder. | +| • Project datastores and buffers | Delivered | Q4 '24 | [Issue 2190](https://github.com/OpenFn/lightning/issues/2190) | Allow users to configure a data store or buffer that allows temporary of storage of data that can be used in a workflow. | +| • Make User Onboarding better with resources | Delivered | Q4 '24 | [Issue 2523](https://github.com/OpenFn/Lightning/issues/2523) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | +| • Snapshots and Audit Trail | In dev | Q4 '24 | [Issue 2526](https://github.com/OpenFn/Lightning/issues/2526) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | +| • Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | +| • Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | +| • OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | +| • Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | +| • Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | +| • Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | +| • Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | +| • Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | +| • Enable sandbox and production modes | Tracked | Q1 '25 | [Issue 2524](https://github.com/OpenFn/Lightning/issues/2524) and [Issue 2525](https://github.com/OpenFn/Lightning/issues/2525) | Allow users to be able to switch between sandbox and production modes in their projects. | +| • Control log output and levels | Tracked | Q1 '25 | [Issue 1755](https://github.com/OpenFn/Lightning/issues/1755) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | +| • Enhanced websocket worker Monitoring | Tracked | Q1 '25 | [Issue 608](https://github.com/OpenFn/kit/issues/608) | Give users better visibility of what's happening on inside the worker, especially when an error occurs during run execution. | _You can follow Lightning's progress and track delivered features in the [Changelog](https://openfn.github.io/lightning/changelog.html)._ @@ -151,21 +148,21 @@ databases, and even raw data files, enabling interoperability with any information system ([read more](/adaptors/)). Adaptors, alongside OpenFn's workflow engine, enable automated workflows that cut across digital systems. -| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | -| ------------------------------------------------------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | -| 3. Enhancements to [`FHIR`](http://www.hl7.org/fhir/) & [`OpenHIM`](http://openhim.org/) adaptors | Delivered | Q3 2024 | See existing adaptors for [FHIR](/adaptors/packages/fhir-docs) and [OpenHIM](/adaptors/packages/openhim-docs) | To rebuild the existing 2021 [OpenFn Instant-OpenHIE reference demo](/documentation/get-started/standards#openhie-standard-architecture) to highlight the exchange of data between existing non-FHIR digital health tools and a HAPI FHIR server. (OpenFn Lightning is OpenHIE-compliant and can be used as a workflow engine for the OpenHIE Interoperability layer - [learn more here](/documentation#openfn-v2-lightning-#standards-and-compliance-matter).) We also want to demonstrate data exchange between existing non-FHIR digital health tools and key components of Google's [Open Health Stack](https://developers.google.com/open-health-stack) and [Cloud Healthcare API](https://cloud.google.com/healthcare-api/docs/concepts/fhir) | -| 4. Enhancements to the [`OCL`](https://openconceptlab.org/) adaptor | Tracked | Q1 2025 | [See existing adaptor docs](/adaptors/packages/ocl-readme) | To ensure that mappings stored in OCLs can be more easily access and processed as inputs in OpenFn/Lightning workflows | -| 5. Implement [MOSIP](https://mosip.io/#1) Adaptor | Tracked | Q1 2025 | [Issue 737](https://github.com/OpenFn/adaptors/issues/737) | Add an adaptor that enables users to integrate with MOSIP for identity management use cases across countries. | -| 6. Implement [OpenCRVS](https://www.opencrvs.org/) Adaptor | Tracked | Q1 2025 | [Issue 736](https://github.com/OpenFn/adaptors/issues/736) | Enable OpenFn workflows to integrate with OpenCRVS for CRVS workflows. | -| 7. Implement [ArcGIS](https://www.arcgis.com/) Adaptor | Tracked | Q1 2025 | [Issue 738](https://github.com/OpenFn/adaptors/issues/738) | Add an ARCGIS adaptor for users to build weorkflow that manage data sync between source and online maps with OpenFn Workflows. | -| 8. Support Personal Access Tokens in DHIS2 | Tracked | Q1 2025 | [Issue 697](https://github.com/OpenFn/adaptors/issues/697) | Extend the DHIS2 Adaptor to support Personal Access Token(PAT). | +| **Feature** | **Status** | **Timeline** | **Link(s)** | **Description** | +| ------------------------------------------------------------------------------------------------ | ---------- | ------------ | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| • Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | +| • Enhancements to [`FHIR`](http://www.hl7.org/fhir/) & [`OpenHIM`](http://openhim.org/) adaptors | Delivered | Q3 2024 | See existing adaptors for [FHIR](/adaptors/packages/fhir-docs) and [OpenHIM](/adaptors/packages/openhim-docs) | To rebuild the existing 2021 [OpenFn Instant-OpenHIE reference demo](/documentation/get-started/standards#openhie-standard-architecture) to highlight the exchange of data between existing non-FHIR digital health tools and a HAPI FHIR server. (OpenFn Lightning is OpenHIE-compliant and can be used as a workflow engine for the OpenHIE Interoperability layer - [learn more here](/documentation#openfn-v2-lightning-#standards-and-compliance-matter).) We also want to demonstrate data exchange between existing non-FHIR digital health tools and key components of Google's [Open Health Stack](https://developers.google.com/open-health-stack) and [Cloud Healthcare API](https://cloud.google.com/healthcare-api/docs/concepts/fhir) | +| • Enhancements to the [`OCL`](https://openconceptlab.org/) adaptor | Tracked | Q1 2025 | [See existing adaptor docs](/adaptors/packages/ocl-readme) | To ensure that mappings stored in OCLs can be more easily access and processed as inputs in OpenFn/Lightning workflows | +| • Implement [MOSIP](https://mosip.io/#1) Adaptor | Tracked | Q1 2025 | [Issue 737](https://github.com/OpenFn/adaptors/issues/737) | Add an adaptor that enables users to integrate with MOSIP for identity management use cases across countries. | +| • Implement [OpenCRVS](https://www.opencrvs.org/) Adaptor | Tracked | Q1 2025 | [Issue 736](https://github.com/OpenFn/adaptors/issues/736) | Enable OpenFn workflows to integrate with OpenCRVS for CRVS workflows. | +| • Implement [ArcGIS](https://www.arcgis.com/) Adaptor | Tracked | Q1 2025 | [Issue 738](https://github.com/OpenFn/adaptors/issues/738) | Add an ARCGIS adaptor for users to build weorkflow that manage data sync between source and online maps with OpenFn Workflows. | +| • Support Personal Access Tokens in DHIS2 | Tracked | Q1 2025 | [Issue 697](https://github.com/OpenFn/adaptors/issues/697) | Extend the DHIS2 Adaptor to support Personal Access Token(PAT). | ### Docs Roadmap -| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | -| ------------------------------ | ----------- | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. New Lightning User Guidance | In Progress | 2025 | To be hosted on docs.openfn.org | New documentation, videos, and other user guidance on how to use OpenFn/Lightning and how to migrate existing OpenFn/platform projects to Lightning (the new OpenFn "v2") | +| **Feature** | **Status** | **Timeline** | **Link(s)** | **Description** | +| ----------------------------- | ----------- | ------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| • New Lightning User Guidance | In Progress | 2025 | To be hosted on docs.openfn.org | New documentation, videos, and other user guidance on how to use OpenFn/Lightning and how to migrate existing OpenFn/platform projects to Lightning (the new OpenFn "v2") | ## Have questions, feedback or found a bug?