From e7f2c526535c6a0cce5ead7f32d8fd3b6a758bf0 Mon Sep 17 00:00:00 2001 From: John Chilton Date: Mon, 22 Jul 2024 11:00:38 -0400 Subject: [PATCH 1/2] Design goals. --- docs/design.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/design.md diff --git a/docs/design.md b/docs/design.md new file mode 100644 index 0000000..391bc77 --- /dev/null +++ b/docs/design.md @@ -0,0 +1,17 @@ +# gxformat2 Design Considerations + +## Goals + +1) gxformat2 should be human readable and writable +1) gxformat2 should be able to be consumed by Galaxy without access to a Galaxy toolbox +1) gxformat2 should be able to be convertible Galaxy's original workflow format without a Galaxy runtime +1) gxformat2 should align with workflows standards (and specifically the Common Workflow Langauge) when it is pratical +1) We will work on solidifying a version of gxformat2 called 19.09 that is compatible with the workflow models in + Galaxy versions 19.09-24.1 and which can be fixed for older versions with just a gxformat2 dependency upgrade. + At some point in the future there will be a new a version for implementation ideas + the require changes to the Galaxy model. + +## Specific + +John will fill out comments on specific issues here once the goals are merged on. Comments will come in as PRs with pings. + From 47e8483a39c85476ca24033c516129b13131633b Mon Sep 17 00:00:00 2001 From: John Chilton Date: Tue, 23 Jul 2024 09:02:52 -0400 Subject: [PATCH 2/2] Update docs/design.md Co-authored-by: Marius van den Beek --- docs/design.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design.md b/docs/design.md index 391bc77..4cdaabd 100644 --- a/docs/design.md +++ b/docs/design.md @@ -4,7 +4,7 @@ 1) gxformat2 should be human readable and writable 1) gxformat2 should be able to be consumed by Galaxy without access to a Galaxy toolbox -1) gxformat2 should be able to be convertible Galaxy's original workflow format without a Galaxy runtime +1) gxformat2 should be convertible to Galaxy's original workflow format without a Galaxy runtime 1) gxformat2 should align with workflows standards (and specifically the Common Workflow Langauge) when it is pratical 1) We will work on solidifying a version of gxformat2 called 19.09 that is compatible with the workflow models in Galaxy versions 19.09-24.1 and which can be fixed for older versions with just a gxformat2 dependency upgrade.