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

Design goals. #97

Merged
merged 2 commits into from
Aug 18, 2024
Merged

Design goals. #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7f2c52
Design goals.
jmchilton Jul 22, 2024
47e8483
Update docs/design.md
jmchilton Jul 23, 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
17 changes: 17 additions & 0 deletions docs/design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically we're past this already, since we've added conditionals and other things ...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll revise this then! Good point.

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.

Loading